Skip to content

docs(readme): trim What It Does and Features#642

Merged
FuJacob merged 1 commit into
mainfrom
chore/readme-trim-features
Jun 7, 2026
Merged

docs(readme): trim What It Does and Features#642
FuJacob merged 1 commit into
mainfrom
chore/readme-trim-features

Conversation

@FuJacob
Copy link
Copy Markdown
Owner

@FuJacob FuJacob commented Jun 7, 2026

Summary

The What It Does section repeated the feature bullets in a separate paragraph, and the Features list had grown to eight items mixing user-facing actions with implementation details (Two engines), value props (100% on-device, already covered in Privacy), and a settings dump (Make it yours). Cut both back to what isn't already said elsewhere on the page.

Validation

Docs-only change. Rendered the README locally; the four remaining Features bullets line up with the four demo gifs directly above the section.

Linked issues

None.

Greptile Summary

This PR trims README.md in two places: the "What It Does" section loses its second paragraph (which duplicated the Features list), and the Features list shrinks from eight bullets to four by removing items already covered elsewhere on the page (engines, settings, screen-awareness, on-device privacy).

  • The condensed "What It Does" paragraph now reads as a single coherent description instead of repeating what appears just below in Features.
  • The four remaining Features bullets (Ghost-text autocomplete, Emoji autocomplete, Inline macros, One-key autocorrect) correspond directly to the four demo GIFs immediately above, which tightens the visual flow of the page.

Confidence Score: 5/5

Documentation-only change with no code, logic, or configuration touched — safe to merge as-is.

Every removed line is duplicated content that already appears in another section of the same file (Features, Privacy, Engines, Permissions). The trimming reduces noise and creates a clean 1-to-1 mapping between the four demo GIFs and the four remaining Feature bullets, which is exactly what the PR description claims.

No files require special attention.

Important Files Changed

Filename Overview
README.md Docs-only trimming: removed a duplicate second paragraph in "What It Does" and four redundant Feature bullets; no functional or structural issues

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md] --> B[What It Does]
    A --> C[Demo — 4 GIFs]
    A --> D[Features — 4 bullets]
    A --> E[Privacy]
    A --> F[Engines]

    B -->|Before| B1["Intro paragraph\n+ duplicate feature paragraph\n+ privacy line"]
    B -->|After| B2["Intro paragraph\n+ privacy line"]

    D -->|Before| D1["8 bullets\n(features + engines + settings + privacy)"]
    D -->|After| D2["4 bullets aligned with 4 demo GIFs"]

    C -.->|now matches 1-to-1| D2
Loading

Reviews (1): Last reviewed commit: "docs(readme): trim What It Does and Feat..." | Re-trigger Greptile

The feature-recap paragraph in What It Does repeated the bullets below
it, and the Features list had grown to eight items mixing user-facing
actions with implementation details and value props already covered in
the intro and Privacy sections. Cut both to what isn't said elsewhere.
@FuJacob FuJacob merged commit ea54441 into main Jun 7, 2026
4 checks passed
@FuJacob FuJacob deleted the chore/readme-trim-features branch June 7, 2026 21:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant