docs-alignment-update
Keep documentation aligned with behavior and routing.
Procedure
- Identify the canonical source for the changed behavior before editing docs.
- Update public docs, README, playbooks,
AGENTS.md,CLAUDE.mdshims, generated docs, and decision maps only where they route to or explain that source. - For durable ADR or governance docs, keep the Decision Tension Rubric routed through the ADR template, decision map, and agent rules.
- Keep
AGENTS.mdcompact; link to skills or docs for procedures. - Add alignment-check snippets only for durable rules worth enforcing.
- Register new durable docs routers, instruction shims, guardrails, harnesses,
and skills in
docs/discoverability.registry.jsonunderdocs/adr/0017-discoverability-and-meta-code-routing.md. - Remove stale duplicated instructions when a canonical doc or skill supersedes them.
- For closure-gated docs, instruction, ADR, skill, route, storage, permission,
or Clawix/ClawJS integration changes, run
node scripts/discoverability-check.mjs closure --changed-file <path> --json. The closing report must cite the realclaw search ... --jsonandclaw inspect ... --jsonevidence and the discovered artifact, or mark the workPARTIAL/BLOCKED. - Run docs alignment/link checks or record why they cannot run.
Constraints
- Do not make
CLAUDE.mda second instruction source. - Do not duplicate long ADR or playbook content inside
AGENTS.md. - Public docs must not contain private paths, signing identities, or personal workflow instructions.
- Do not close durable docs routing work as complete when CLI discovery cannot find and inspect the affected registered artifact.