Skip to content

The README says it in 180 lines; the other 350 move to the deep dive - #95

Merged
Shashankss1205 merged 1 commit into
mainfrom
readme-diet
Aug 5, 2026
Merged

The README says it in 180 lines; the other 350 move to the deep dive#95
Shashankss1205 merged 1 commit into
mainfrom
readme-diet

Conversation

@Shashankss1205

Copy link
Copy Markdown
Collaborator

Feedback taken: the README was ~530 lines and read like documentation wearing a pitch's clothes. It is now ~185 lines — pitch, demo, install, quick start, the executable admission-gate proof, the comparison table, a five-bullet Limits summary — and everything else moved wholesale to docs/deep-dive.md with links fixed for the new location.

Nothing was deleted; it was demoted. The blocks tests/test_readme.py executes (the admission-gate shell+python pair and the quick-start snippet) are byte-identical, the #limits anchor the website links to survives, and the full suite plus the README executable-docs tests are green.

Also adds a pointer to bench/ from the comparison table — measured third-party comparisons land in the next PR.

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@Shashankss1205
Shashankss1205 merged commit 5576047 into main Aug 5, 2026
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