Skip to content

docs: rewrite README #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
PatrickSys wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: rewrite README #27

PatrickSys wants to merge 1 commit into from
+64 −60

Conversation

@PatrickSys
Copy link
Owner

@PatrickSys PatrickSys commented Feb 10, 2026

Summary

  • Lead with concrete pain examples ("Your AI suggests constructor() when 97% of your team uses inject()") instead of 75 lines of JSON config
  • Reorder value sections to follow user journey: Discovers → Reasons → Remembers → Protects
  • Collapse editor-specific setup into expandable <details> block (saves ~45 lines above the fold)
  • Trim preflight JSON example (remove verbose fields, keep the useful signal)
  • Add 30+ language support mention immediately after the Angular-specific hook to avoid pigeonholing
  • Use possessive "your team" framing throughout

Test plan

  • Only README.md changed
  • First 20 lines lead with pain, not config blocks
  • 30+ language support mentioned in opening section
  • No "Search Quality (v1.6.0)" technical section
  • No eval percentage claims
  • All markdown links resolve (MOTIVATION.md, CHANGELOG.md, CONTRIBUTING.md)

@PatrickSys
docs: rewrite README with pain-first positioning
4944f4b 
- Lead with concrete pain examples instead of config blocks
- Reorder sections: Discovers → Reasons → Remembers → Protects
- Collapse editor-specific setup into expandable details
- Trim preflight JSON example
- Add 30+ language support mention in opening section
- Use possessive "your team" framing throughout
greptile-apps[bot]
greptile-apps bot reviewed Feb 10, 2026
View reviewed changes
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@PatrickSys PatrickSys changed the title docs: rewrite README with pain-first positioning docs: rewrite README Feb 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@PatrickSys