Docs Sync

Workflow

1. Find impacted docs.
   • Prefer fast scan commands, for example:
   • rg --files -g 'README*' -g 'docs/**' -g '**/AGENTS.md' -g '**/CLAUDE.md' -g '.codex/**' -g '.claude/**' -g '.cursor/**' -g '.github/**'
2. Build a propagation list.
   • For every changed command/path/config/pattern, list all files that reference it.
   • Do not stop after updating the first file.
3. Update references consistently.
   • Apply the same terminology and command syntax everywhere relevant.
   • If an AGENTS.md rule changes, update linked guidance files that mirror it.
4. Add or adjust short explanations.
   • Include what changed and why, especially for commands or config behavior.
5. Validate formatting and checks from repo root.
   • pnpm format
   • pnpm lint
   • pnpm typecheck
   • Run pnpm test when doc updates affect behavior descriptions, test commands, or validation expectations.
6. Summarize with explicit output sections.

Writing Guidelines

• Keep docs concise and scannable.
• Prefer concrete commands and examples.
• Use consistent names for workspaces, scripts, and directories.
• Update dates/versions when present.
• Remove obsolete sections instead of leaving TODO-style placeholders.

Required Final Output

Always finish with:

• Files changed: list each documentation file updated.
• What to review: call out text that needs human wording/accuracy review.
• Validation status: report results for pnpm format, pnpm lint, pnpm typecheck, and pnpm test (if run).