Trim the documentation to what each document needs - #3603
Merged
Conversation
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Applies one rule across the repo's prose: cover the substance, then stop. No filler sections, restated summaries or boilerplate. The rule itself is now recorded in
AGENTS.mdunder## Writing, since the repo had demonstrably drifted without it.Four commits, one per area.
examples/*/README.md— 15 of the 17 were byte-identical below their title line: the same CRA-derived "Available Scripts" block, accurate but saying nothing about the example. Each is now two lines, what it demonstrates plus how to run it.ssrandno-extensionalready had specific content; they keep it and lose the ceremony.test/manual/README.md(235 → 200) — the operating instructions were 8 lines buried a third of the way down, under three sections of preamble. They now lead. The three overlapping "what this does not cover" passages are one section. Both recorded-run tables carry forward verbatim; the paragraphs restating what those tables already showed are gone.AGENTS.md(106 → 102) — it andtest/manual/README.mdwere near-duplicates on the harness rationale, down to the clause "automating it would mean simulating the thing it exists to escape" appearing word-for-word in both. The README wins the rationale, since it's only needed once you've opened the harness.AGENTS.mdkeeps the pointer and the obligation, which is what an agent needs at the moment it editssrc/.README.md—Backgroundmerges intoWhen To Use This; they answered the same question. The FAQ's data-URI entry restated thesrcprop docs and made a third pass at the DOMPurify advice already inSecurity, so it's down to the part only it answers.Out of scope, deliberately
MIGRATION.md— entry length is proportional to the work a consumer has to do.src/comments —AGENTS.mddeliberately routes rationale there, so trimming would just relocate the problem somewhere with less context.Testing
No manual harness re-run. Nothing in
src/ortest/manual/*.mjschanged — this is prose only, so the recorded runs remain accurate as written.🤖 Generated with Claude Code