docs-sync-checker

Installation
SKILL.md

Documentation Sync Checker Skill

Deterministic 4-phase drift detector that compares the filesystem against README entries. Each phase (Scan, Cross-Reference, Detect, Report) has a gate that must pass before proceeding. The skill produces a sync score (percentage of tools properly documented) and actionable fix suggestions for every detected issue.

This skill checks documentation presence and absence only -- it does not judge description quality, generate documentation content, resolve merge conflicts, validate cross-references, or track when drift occurred. Suggested fixes use YAML descriptions verbatim; content generation and quality assessment require different skills.

Optional flags: --auto-fix (experimental, requires explicit opt-in), --strict (exit code 1 on issues), --format json (machine-readable output for CI/CD).


Reference Loading Table

Signal Load These Files Why
documentation work documentation-structure.md Loads detailed guidance from documentation-structure.md.
before/after doc-update examples: adding skill docs, removing deprecated agent docs examples.md Loads detailed guidance from examples.md.
wiring the checker into CI, pre-commit, or auto-fix mode integration-guide.md Loads detailed guidance from integration-guide.md.
expected table and list formats per README file markdown-formats.md Loads detailed guidance from markdown-formats.md.
which docs must list which tools; sync score and deprecation rules sync-rules.md Loads detailed guidance from sync-rules.md.
Installs
15
GitHub Stars
416
First Seen
Mar 23, 2026
docs-sync-checker — notque/vexjoy-agent