Docs Review Checklist
Use this checklist before merging public docs changes or declaring a native release docs-ready.
CLI
- Commands, flags, defaults, examples, and error guidance match current source material.
- Generated CLI help has been compared with native implementation or tests for user-facing command behavior.
- Any added, removed, renamed, or behavior-changing CLI command or flag has a matching public docs update, validation update, or approved deferral issue.
- Exact output and version strings are included only when source-backed and stable for the release.
- CLI tasks link to equivalent GUI paths where both exist.
GUI
- Navigation paths, labels, buttons, menus, and panels match current product source or approved screenshots.
- Any added, removed, renamed, or behavior-changing GUI surface has a matching public docs update, screenshot update, validation update, or approved deferral issue.
- GUI tasks link to equivalent CLI guidance where both exist.
- Any missing GUI coverage is labeled source-needed or deferred.
Screenshots
- screenshots are current, approved, and not replaced by fake app imagery.
- Placeholder screenshots are clearly labeled as placeholders.
- Screenshot alt text names the actual product state shown.
- Screenshots that show hostnames, domains, local paths, account identifiers, registry hosts, private image names, secrets, or customer data are redacted or replaced with fixture-backed captures.
Source capture and drift prevention
- Source captures under
docs/source-captures/**identify the CLI help output, native GUI source/tests, screenshots, installer docs, or release notes used to verify the public docs change. - Durable public contracts are backed by validators or browser tests where practical: screenshots, key headings, defaults, command examples, source warnings, and maintainer policy text.
- Native MacTain release readiness checks include the public docs change, linked website docs PR, or approved deferral record.
- Public documentation is changed only under
apps/docs/docs/**; no native docs directory, sync workflow, or generated mirror is treated as a second authoring source.
Claims
- claims about pricing, licensing, billing, privacy, legal commitments, deployment, releases, and customer support match approved source material.
- Unsupported marketing or product claims are removed or labeled source-needed.
Links and validation
- Internal links resolve.
- Frontmatter previous/next links resolve.
- VitePress nav and sidebar links resolve.
- Search/build validation passes through the docs validation command.
Launch validation
- Run the repeatable docs launch validation sequence from
docs/docs-launch-validation.mdbefore declaring docs launch-ready. - Source-evidence, quality, IA, link, build, and browser checks all pass, or failures are explicitly deferred by an approved launch decision.