docs(readme): make it scannable without deleting a word - #181
Merged
Conversation
Three places dumped everything at once. The section order was never the problem — Who This Is For -> What It Does -> How It Works -> Install -> Build Your Own is fine. 1. The Status line was a single 1,049-character sentence carrying test counts, a posture caveat, four benchmark scores, the depth matrix, a feature list and two links. Now a one-line status, a scoreboard table, and a collapsible "why two test numbers" note. Every fact kept. 2. "New in 0.9.0" was four releases stale. Now leads with 0.9.2.3; the multiplexer keeps its whole section, retitled "Race N agents on one task", because it is still true and still the mission — it just is not "new". 3. The six codename CLIs were 152 lines, 35% of the file, near-identical sections stacked. Now <details> blocks: a reader sees six one-line pitches and opens the one they want. Every character is still in the file. Net: 365 visible lines instead of 433, with 133 lines one click away and 719 characters MORE in the file than before. Verified rather than assumed: a line-by-line diff against the previous README reports only six absent lines, all six being the `### Name — description` headings that became `<summary><b>Name</b> — description</summary>`, each description confirmed present verbatim. No document links the removed anchors. The tagline is byte-identical — checked, not eyeballed. Changing taglines is not mine to do. Co-Authored-By: Claude Opus 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.
The README's structure was never the problem — Who This Is For → What It Does → How It Works → Install → Build Your Own is a good spine. Three specific places dumped everything at once.
What changed
1. The Status line was one 1,049-character sentence. Test counts, a posture caveat, four benchmark scores, the depth matrix, a feature list, and two links, all in a single run-on paragraph. Now: a one-line status, a scoreboard table, and a collapsible note explaining why there are two test numbers.
2. "New in 0.9.0" was four releases stale. Now leads with 0.9.2.3. The multiplexer keeps its entire section, retitled "Race N agents on one task" — it's still true and still the mission, it just isn't new.
3. Six codename CLIs were 152 lines, 35% of the file. Near-identical sections stacked back to back. Now
<details>blocks, so a reader sees six one-line pitches and opens the one they care about:Nothing was deleted
The file is 719 characters larger. Less is shown; nothing is gone.
Verified, not asserted. A line-by-line diff against the previous README reports exactly six absent lines — all six the
### Name — descriptionheadings that became<summary><b>Name</b> — description</summary>, with each description confirmed present verbatim. No document inREADME.md,docs/orsite/links the anchors those headings provided.The tagline is byte-identical, checked programmatically rather than by eye. Changing taglines isn't mine to do.
Gates: claims + repo-hygiene 75 passed (the claims gate scans
README.md, so the new benchmark table is checked against its receipts).🤖 Generated with Claude Code