docs: full documentation audit + remediation#72
Merged
Conversation
Audit all of docs/ (564 files) + CLAUDE.md/README.md for accuracy, quality, and spec alignment, and fix every finding. Documentation-only — no code changed (verified: only docs/, CLAUDE.md, README.md, .claude/skills touched). The docs lagged the code: an adversarial code-verification pass over every flagged spec<->code mismatch confirmed ZERO code defects. The dominant failure was stale "deferred/draft" status left in place after work shipped. - Catalog: new ### Render area; 11 missing plan entries added (render r1/r2/r6, the GPU-verify campaign, editing e1-e6, follow-ups.md); dead reference-designs link + stray list break removed; "Where to start" expanded to 5; broken prior-art cross-refs repointed. - Statuses flipped to reality across specs/plans: render-pipeline spec [draft]->[active], docs-org [draft]->[landed], R8 [partial]->[superseded], R8b/R9 ->[landed], T9 proposed->landed, editing e1-e6, the 5 render sub-designs, open-questions, text README; the non-standard [partial] is gone everywhere. - Misleading "deferred/future" claims rewritten to landed reality across the layout/render/text/verification specs and follow-ups.md (the layout pipeline now lists steps 0-9 + text; TaffyTree<Entity>; the Transform bridge; node_skip_reason; the GPU-orchestration framing; matrix_goldens). - Authored the 2 missing prior-art READMEs (bevy-a11y, bevy-feathers); swept 51 files of fictional /home/user/buiy paths to repo-relative; converted drifted :NNNN citations to symbol-only. - Added 3 audit docs: the findings report, this remediation plan (executed), and a code-side findings report (stale in-code comments + dead-legacy extract path — open for a separate session; no functional code defects). Decision: the 5 dated render-pipeline children were NOT renamed (renaming would break path references in 5 code files); they are blessed as a documented exception in the docs-organization spec + organizing-buiy-docs skill instead, keeping this change documentation-only. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
# Conflicts: # docs/README.md # docs/prior-art/bevy-ui/lessons.md # docs/specs/2026-05-08-buiy-layout-design/transforms-and-containment.md
- Drop version-specific '0.18' label from the Bevy outer-tuple-cap comment (the 15-element cap is not version-specific; tree is now 0.19). - Convert a drifted metric.rs:31-37 line citation to symbol-only (per the audit's own F4 recommendation). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This was referenced Jun 19, 2026
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.
Summary
A full audit of
docs/(564 files) +CLAUDE.md/README.mdfor accuracy, quality, and spec alignment, with every finding fixed. Documentation-only — no code changed.Headline: the docs lagged the code. An adversarial code-verification pass over every flagged spec↔code mismatch confirmed zero code defects — the implementation matches/exceeds the specs; the docs simply weren't flipped when work landed. The dominant failure was stale "deferred/draft" status left in place after subsystems shipped (the most dangerous class, since it invites re-implementing landed work).
110 raw findings → ~50 distinct issues, all resolved. Full detail:
docs/reports/2026-06-18-docs-audit.md; ordered fix:docs/plans/2026-06-18-docs-audit-remediation.md.What changed
### Renderarea; 11 missing plan entries added (render r1/r2/r6, the GPU-verify campaign, editing e1–e6,follow-ups.md); deadreference-designs/link + stray list break removed; "Where to start" expanded to 5; broken prior-art cross-refs repointed.[draft]→[active], docs-org[draft]→[landed], R8[partial]→[superseded], R8b/R9→[landed], T9proposed→landed, editing e1–e6, the 5 render sub-designs, open-questions, text README; the non-standard[partial]is gone everywhere.follow-ups.md(pipeline now lists steps 0–9 + text;TaffyTree<Entity>; the Transform bridge;node_skip_reason; the GPU-orchestration framing; matrix_goldens).bevy-a11y,bevy-feathers); swept 51 files of fictional/home/user/buiypaths to repo-relative; converted drifted:NNNNcitations to symbol-only.Decision recorded
The 5 dated render-pipeline children were not renamed — renaming would break path references in 5 code files — so they're blessed as a documented exception in the docs-organization spec +
organizing-buiy-docsskill, keeping this change documentation-only.Verification
119 files changed, 5 new. Mechanical gates clean: catalog↔filesystem 0 missing entries, internal-link scan 0 broken links, doc-header statuses all standard, no code file touched. Per-subsystem prose rewrites were independently re-reviewed against the code.🤖 Generated with Claude Code