Skip to content

gate: website command docs enumerated against the command registry #1420

Description

@thymikee

Part of #1412 (Track B).

Context

website/docs/docs/commands.md is hand-written; only slivers are test-guarded (cdp/react-devtools doc tests). With the CommandDescriptor registry complete (ADR 0008/0009), docs can drift silently when commands are added, renamed, or retired.

Deliverables

  • A unit-lane gate: every id in PUBLIC_COMMANDS appears in commands.md; no documented command is absent from the registry; explicit waiver list (with reasons) for intentional omissions.
  • Stretch (separate PR if large): generate the command reference skeleton (name, usage line, flags) from the registry/schema so prose is additive and the generated block is diff-checked.

Acceptance

  • Adding a public command without touching commands.md fails with a message naming the file and the missing command.
  • Retiring a command with stale docs fails symmetrically.
  • Zero false positives on current main (fix any real drift found as part of this issue and list it in the PR).

Review amendments (2026-07-27)

  • VERIFIED: main CI ignores website/** (ci.yml paths-ignore), so this gate as originally scoped would never run on a docs-only change. Either run the gate inside the docs build/preview workflow (pr-preview.yml/deploy.yml path) or remove the relevant docs file from paths-ignore. The gate-manifest issue (gate-of-gates: derived manifest proving every check is owned, wired, and reachable #1429) generalizes this reachability class — coordinate with it.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions