docs-sync-checker

Featured

Detect documentation drift against filesystem state.

Data & Documents 425 stars 46 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 96/100

Stars 20%
88
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# 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). --- ## Instructions ### Phase 1: SCAN **Goal**: Discover all skills, agents, and commands in the repository filesystem. All discovery (file existence checks, YAML parsing, markdown extraction) must be deterministic -- no AI judgment on content quality. **Step 1: Run the scan script** ```bash python3 skills/meta/docs-sync-checker/scripts/scan_tools.py --repo-root $HOME/vexjoy-agent ``` **Step 2: Validate discovery results** For each tool type, verify: Skills (`skills/**/SKILL.md`): - File has opening `---` and closing `---` YAML delimiters - YAML contains non-empty `name` and `description` fields - `name` field matches directory name (e.g....

Details

Author
notque
Repository
notque/vexjoy-agent
Created
6 months ago
Last Updated
yesterday
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category