sync-docs
Installation
SKILL.md
sync-docs
Catches docs that have fallen out of sync with the code on the current branch. The skill diagnoses + proposes; the user (or Claude under user direction) applies the edits.
When to invoke
- Proactively after editing files under
src/— especiallysrc/index.ts(public exports) or anysrc/<area>/index.ts(per-area re-exports). - Before
gh pr createwhen the branch has src/ changes. The PreToolUse hook in.claude/settings.jsonblocks PR creation if docs drift is detected and no opt-out is set — running this skill is the natural way to clear the block. - Whenever the public surface shifts — a new public export, a renamed symbol, a removed helper, a default-value change, an exception body change, a new module option.
Output contract
Two sections: