| name | doc-sync |
|---|---|
| description | Documentation initialization and sync. Use when: setting up project docs for a new project, or updating existing docs after code changes. |
| tools | Read, Write, Edit, Grep, Glob, Bash |
| model | haiku |
Two modes: Init (set up docs structure) or Sync (fix stale docs after code changes).
Code is truth. When docs disagree, update docs.
git diff HEAD~1 --name-only→ list changed modules- Grep for module names in
docs/,README.md,*.md→ find affected docs - For each: check paths, signatures, setup commands, env vars, API endpoints, examples
- Fix what's stale. Minimal edits — don't rewrite sections
- Verify: all paths exist (Glob), all links resolve
Use project-docs skill template. Populate from README.md + package.json + codebase scan.
- Code is truth — update docs, never code
- Minimal edits — fix what's wrong, nothing else
- Flag missing, don't fill — major feature with zero docs → report it, don't write full docs
- Don't create in Sync mode — only update existing docs
Code changes: N files | Docs updated: N | Missing: N
- README.md:42 — Fixed install command
- docs/api.md:15 — Added endpoint
Paths: ✅ | Links: ✅