Pre-release / final pass checklist (docs)
Use this list before calling a development phase “done” when the repo has seen path, API, or behavior churn. Tick items after you re-read or update the file.
High impact
-
docs/architecture/tree/README.md— repo layout,packages/*,apps/*, notabledocs/entries. -
docs/README.md— top-level index links still valid. -
docs/json/README.md— envelope, command list, links toissue-codes, long-running JSON behavior. -
docs/exports/core.md— stable vs advanced table matches exports; new programmatic entrypoints documented.
Cross-cutting
-
docs/cli/README.md— global flags,--jsonpointer. -
docs/commands/README.md— orchestration link. -
docs/behavior/commands.md— snapshot table vs reality. -
apps/web—docsUrl(...)targets for marketing / API pages. - Run
pnpm run docs:syncsoapps/docs/content/matchesdocs/.
Optional deep pass
- Command READMEs you touched this phase.
- ADR “See also” links if folders moved.
-
docs/phases/**completion notes vs what actually shipped. - Comment & JSDoc cleanup (noise vs signal) — trim redundant comments; one JSDoc per constant group where possible; rich JSDoc on important public APIs.
This file is tracked in git. Session scratch work belongs in ignored docs/phases/temp/ — see agents/temp-notes.md.