docs: rewrite README as a positioning-first pitch#20
Merged
Conversation
Lead with a tagline, three-sentence positioning, badges, and a hero screenshot; collapse the 22-bullet feature wall into four differentiators (semantic-layer accuracy, built-in governance, self-hosted/BYO-LLM, MCP); fix the placeholder clone URL and the model-routing overclaim. Relocate the deep documentation (nothing deleted): MCP client setup to docs/mcp.md, env vars + provider/connection guides to docs/configuration.md, REST tables to docs/api-reference.md, and no-Docker setup + project tree + extension guides to docs/development.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
What
Rewrites the README as a positioning-first pitch (~200 lines, down from ~850) and relocates the deep documentation it displaced into
docs/— nothing is deleted, only moved.Why
The old README was excellent documentation but a weak landing page: it opened with an implementation description instead of a value proposition, buried the differentiators (governance, self-hosted/BYO-LLM, MCP) in a 22-bullet feature wall, used none of the 9 screenshots in
screenshots/, had a literal<repo-url>placeholder in the Quick Start, and overclaimed the model routing ("haiku → sonnet → opus") versus what the router actually does.Changes
screenshots/query2.png) alongside the demo videoapp/llm/router.py); roles corrected to viewer/editor/admin🤖 Generated with Claude Code