docs: the three claim pages show the thing before naming it - #230
Merged
Merged
Conversation
They read as explanations of the specification rather than answers to a question somebody arrived with. Each opened with a definition, moved to distinctions, and reached anything concrete four screens down under "See it hold". `no-execution.md` reached paragraph three before showing anything, and paragraph three was profiles, revival, serialization, envelopes and constructors: six unfamiliar nouns, none of them load-bearing for a reader deciding whether to care. Two habits made them professorial. They corrected claims the reader had not made — "That is TypeScript's type checker, and it is not linting", "The specification defines no such check. It defines the contract a host's checks run under" — and they explained distinctions before the reader had hit the problem the distinction solves. Each page now opens on something that happens to you. Your config says a repo has no wiki. A tool reads it and tells you what it will deploy. You set two settings that contradict each other and nothing tells you. You already have infrastructure, and you want it as TypeScript without hand-copying a thousand lines and hoping. Then the name, once, after the thing has been seen. The profile distinction leaves the pages almost entirely, from nine mentions across the three to one. `data-host` versus `full` is an implementer's concern, and the two places it genuinely bears on a claim now say "with no JavaScript runtime" instead. One of those mentions was mine, added in yesterday's limits pass, in an opening paragraph. Gone too: "quantifying over the binding space is still a model-checking problem", "a YAML-to-YAML round trip is the identity", and a five-item comma series I wrote while collapsing a list that was already readable. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AzfJnYw9p6rAxhJqXK3CPv
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.
Read all three as a TypeScript and IaC novice. They're professorial and they over-explain, and those are the same disease.
What was wrong
They teach before they show. Each opened with a definition, moved to distinctions, and reached anything concrete four screens down under "See it hold".
no-execution.mdreached paragraph three before showing anything, and paragraph three was:Six unfamiliar nouns, none load-bearing for someone deciding whether to care.
They correct claims the reader never made. That's the professorial tell:
Three sentences of "it isn't X, it's the contract governing X" before the reader has seen a single rule.
Now
Each page opens on something that happens to you, and names it after.
The profile distinction is gone
Nine mentions across the three pages, down to one.
data-hostversusfullis an implementer's concern. The two places it genuinely bears on a claim now say "with no JavaScript runtime" instead.One of those nine was mine, added in yesterday's limits pass, in an opening paragraph.
Also cut
Verification
124 tests in 20 files, prose lint 51 with no regressions, voice gate clean, readability gate clean (rule-id budget unchanged or lower on every page),
npm run docs:buildclean.🤖 Generated with Claude Code
https://claude.ai/code/session_01AzfJnYw9p6rAxhJqXK3CPv