Repository navigation
docs(guide/10): rewrite the war stories as prose, and budget the guide in words - #31
Merged
Merged
Conversation
… words Eight six-row tables were doing the work of eight paragraphs. Each story is now prose in three beats — what happened, why nothing caught it, and a **Fixed** line ending in the commit hash. 2,343 words to 1,734, and the "Symptom | None." rows are gone, since the TL;DR already says none of these crashed. Two things had to be fixed before it was safe to compress: - **Stories 6, 7 and 8 said `Commit | this PR`.** A placeholder that went stale on merge, in the three stories with no ADR behind them — so the page was the only readable record of them and there was nothing to link down to. All three are `f5c8363`, which is on main and whose message is the long version. That makes "git show any hash above" true for all eight, which is what licenses the page to be a summary. - The chapter had **no "Where this lives in code" section**, which the shape rule requires and `docs:lint` does not check. Added, with the four files the stories bought. Also dropped the per-story "the general form is…" paragraphs, which restated what § The pattern already tabulates one row per story. ── The budget is now words, not lines ────────────────────────────────────── Lines have now given the wrong answer twice, in opposite directions. Counting fenced blocks punished chapter 03's Mermaid. Excluding them let this chapter pass at 183 lines while it was the longest page in the guide by 65%: its content sat in table cells at ~13 words a line where prose runs ~9. The rewrite cut 500 words and *added* 30 lines — a measure that moves the wrong way under a real improvement is the wrong measure. `≤ ~150 lines` becomes `≤ ~1,400 words`, measured with `wc -w`. Every other chapter already passes (900–1,400). Chapter 10 is the stated exception and is budgeted per item instead — ~150 words a story — so a ninth story buys 150 words rather than an open page, with the split seam named in case it outgrows that: corpus bugs that shipped (1–5) against measurement bugs a refusal caught (6–8). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
ancsingabor
added a commit
that referenced
this pull request
Sep 30, 2026
Branch protection requires an up-to-date head branch; #31 landed first. 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.
Eight six-row tables were doing the work of eight paragraphs. Each story is now prose in three beats — what happened · why nothing caught it · what changed — ending in the commit hash. 2,343 → 1,734 words.
Two defects that had to be fixed first
Commit | this PR— a placeholder that went stale on merge, in exactly the three stories with no ADR behind them. So the page was their only readable record, and there was nothing to link down to. All three aref5c8363, onmain, whose commit message is the long version. That makes "git showany hash above" true for all eight — which is what licenses this page to be a summary rather than the record.docs:lintdoes not check. Added, with the four files the stories bought.Also dropped the per-story "the general form is…" paragraphs, which restated what
§ The patternalready tabulates one row per story, and theSymptom | None.rows, since the TL;DR already says none of these crashed.The line budget was measuring the wrong thing
Lines have now given the wrong answer twice, in opposite directions:
Chapter 10's content sat in table cells at ~13 words a line where prose runs ~9, so the budget never saw it. This rewrite cut 500 words and added 30 lines — a measure that moves the wrong way under a real improvement is the wrong measure.
≤ ~150 lines→≤ ~1,400 words, measuredwc -w. Every other chapter already passes:Chapter 10 is the stated exception and is budgeted per item instead, because it is a collection whose unit is the story: ~150 words a story plus the shared sections. A ninth story buys 150 words, not an open page — and the split seam is named in case it outgrows that (corpus bugs that shipped, 1–5, against measurement bugs a refusal caught, 6–8).
All seven hashes verified to resolve on
main.docs:lintgreen.🤖 Generated with Claude Code