docs(readme): trim What It Does and Features#642
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdin 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).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
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| D2Reviews (1): Last reviewed commit: "docs(readme): trim What It Does and Feat..." | Re-trigger Greptile