Skip to content

docs(readme): make it scannable without deleting a word - #181

Merged
0bserver07 merged 1 commit into
masterfrom
docs/readme-accessible
Aug 6, 2026
Merged

docs(readme): make it scannable without deleting a word#181
0bserver07 merged 1 commit into
masterfrom
docs/readme-accessible

Conversation

@0bserver07

Copy link
Copy Markdown
Owner

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:

▸ Otter  — server-first coding agent
▸ Ferret — sandbox-first IDE-flagship coding agent
▸ Weasel — minimal harness with four operating modes
▸ Shrew  — tuned for small local models
▸ Stoat  — shell-mode-toggle coding agent
▸ Badger — harness-rewrite coding agent

Nothing was deleted

before after
file 433 lines / 27,892 chars 498 lines / 28,611 chars
visible before expanding 433 365
one click away 133

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 — description headings that became <summary><b>Name</b> — description</summary>, with each description confirmed present verbatim. No document in README.md, docs/ or site/ 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

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>
@0bserver07
0bserver07 merged commit d9a4077 into master Aug 6, 2026
8 checks passed
@0bserver07
0bserver07 deleted the docs/readme-accessible branch August 6, 2026 06:03
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