Skip to content

docs: README should tell a story, not list features#191

Merged
DevanshuNEU merged 1 commit into
mainfrom
docs/readme-storytelling
Jan 9, 2026
Merged

docs: README should tell a story, not list features#191
DevanshuNEU merged 1 commit into
mainfrom
docs/readme-storytelling

Conversation

@DevanshuNEU

Copy link
Copy Markdown
Collaborator

Summary

Rewrites the README to tell a story instead of listing features.

What changed

Before: Technical description, feature list, "MCP server" identity

OpenCodeIntel gives AI coding assistants deep understanding of your codebase. 
It's an MCP server that provides semantic code search...

After: Pain point first, show don't tell

You know that mass of code you inherited? The one where you spend 20 minutes 
grep-ing just to find where authentication happens?

OpenCodeIntel fixes that.

Key improvements

  1. Opens with the pain — Every developer knows the feeling of being lost in a codebase
  2. Shows real examples — Table with actual search queries and what they find
  3. Concise features — One-liner descriptions, not bullet point lists
  4. De-emphasized MCP — It's in a collapsible section, not the identity
  5. Collapsible setup — Manual setup and MCP config hidden by default (clean)
  6. Shorter overall — ~120 lines vs ~145 lines (shadcn-style confidence)

Inspiration

  • shadcn/ui: Brevity = confidence. 15-line README, 80k stars.
  • Cal.com: Relatable opening, positions against known pain
  • Supabase: Clean architecture diagrams, clear "what it does"

Comparison

Metric Before After
Lines 145 ~120
Opens with Technical description Developer pain point
Features Bullet list Table with real examples
MCP mention In tagline In collapsible section
Tone Corporate docs Developer talking to developer

Screenshots

Will add after merging (need to see rendered markdown)


Closes #190

- Lead with the pain point developers feel
- Show real examples instead of listing features  
- De-emphasize "MCP server" as identity
- Keep it concise (shadcn-style confidence)
- Add actual search examples that resonate

Closes #190
@vercel

vercel Bot commented Jan 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Review Updated (UTC)
opencodeintel Ignored Ignored Jan 9, 2026 0:06am

@DevanshuNEU DevanshuNEU merged commit d505919 into main Jan 9, 2026
10 checks passed
@DevanshuNEU DevanshuNEU deleted the docs/readme-storytelling branch January 9, 2026 00:38
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.

docs: README should tell a story, not list features

1 participant