skill-readme-sync
Installation
SKILL.md
Skill README Sync
Checks that a skill's README.md accurately reflects its SKILL.md after every edit, then proposes updates to close any gaps.
Purpose
Detect and resolve mismatches between a SKILL.md and its README.md after every edit so that documentation never drifts from implementation.
Trigger
Apply automatically after any edit to a SKILL.md file. Also trigger when:
- "sync README", "update README", "README out of date", "README 沒更新", "README 跟 skill 不一樣"
Do NOT trigger for:
- Edits to README.md only — README is documentation, SKILL.md is the source of truth
- Brand-new skill creation —
skill-audithandles the initial delivery check - Edits to non-skill files