docs: documentation management overhaul (decision record)#387
Draft
interacsean wants to merge 1 commit into
Draft
docs: documentation management overhaul (decision record)#387interacsean wants to merge 1 commit into
interacsean wants to merge 1 commit into
Conversation
One-way source→output docs pipeline: authored outlines drive AI-synthesized docs + runnable examples, gated deterministically pre-merge by interface/ outline hashing and index.ts coverage reconciliation. Retires the post-merge docs-update bot in favour of a blocking check + local resync-docs skill. Co-Authored-By: Claude Opus 4.8 <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
1 participant
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.
What
Adds
decisions/documentation-management-overhaul.md— an ADR-style decision record for reworking how docs are authored, generated, and kept from drifting.Why
All ~65 docs are hand-maintained today with no enforced source↔doc link, so API drift is invisible (e.g.
timeline.mddocuments a component not exported fromindex.ts). The existingdocs-update.lock.ymlbot only patches drift after merge, heuristically.The decision (summary)
source → output. Humans edit only*.docs-outline.md(prose + English example intents +sources); AI (resync-docsskill) synthesizes the.md, a runnable[unit].examples.tsx, and the manifest. Nothing generated is ever hand-edited.check-docsscript hashes the type surface + outline (+ advisory snapshot) and reconciles againstindex.tsboth ways, so a forgotten/undocumented export blocks CI. Output hashes are tracked too — a hand-edited generated file fails CI.examples.tsxper unit;.mdfences are extracted from it (shown === runs). A dedicated AppShell-based renderer app globs them in place (no copy).The full workflow diagram (Mermaid, renders inline on GitHub) and verification plan are in the doc.
Note
This PR is a decision record only — no pipeline code yet. Opening as draft for team review of the approach before implementation.
🤖 Generated with Claude Code