Skip to content

Trim the documentation to what each document needs - #3603

Merged
tanem merged 4 commits into
masterfrom
trim-documentation
Aug 6, 2026
Merged

Trim the documentation to what each document needs#3603
tanem merged 4 commits into
masterfrom
trim-documentation

Conversation

@tanem

@tanem tanem commented Aug 6, 2026

Copy link
Copy Markdown
Owner

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.md under ## 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. ssr and no-extension already 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 and test/manual/README.md were 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.md keeps the pointer and the obligation, which is what an agent needs at the moment it edits src/.

README.mdBackground merges into When To Use This; they answered the same question. The FAQ's data-URI entry restated the src prop docs and made a third pass at the DOMPurify advice already in Security, 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.md deliberately routes rationale there, so trimming would just relocate the problem somewhere with less context.
  • The manual harness's rationale itself. Cutting reasoning that records real wrong turns is worth doing deliberately, not as a side effect of a length sweep.

Testing

No manual harness re-run. Nothing in src/ or test/manual/*.mjs changed — this is prose only, so the recorded runs remain accurate as written.

🤖 Generated with Claude Code

tanem and others added 4 commits August 7, 2026 05:37
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>
@tanem
tanem merged commit de52a2f into master Aug 6, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant