docs-sync-checker

Compare filesystem tools against README and docs to detect documentation drift.

415|44|Updated Mar 18, 2026
One-click install
npx skills add https://github.com/notque/claude-code-toolkit --skill docs-sync-checker
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync-checker
Source: https://github.com/notque/claude-code-toolkit/tree/main/skills/docs-sync-checker
Command: npx skills add https://github.com/notque/claude-code-toolkit --skill docs-sync-checker

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Scans repository tooling (skills, agents, and commands) and compares filesystem definitions with documentation to detect drift, missing entries, and version inconsistencies.

Core Features & Use Cases

  • Deterministic 4-phase workflow: Scan, Cross-Reference, Detect, and Report to ensure full coverage.
  • YAML frontmatter and README parsing across skills/README.md, agents/README.md, commands/README.md, and docs/REFERENCE.md to surface inconsistencies.
  • Actionable remediation guidance: generates precise fixes for missing, stale, and mismatched entries.
  • CI/CD friendly: can run in strict mode to fail builds on drift and support machine-readable JSON output.

Quick Start

Run the drift check to scan tooling, cross-reference documentation, detect issues, and generate a remediation report.

Frequently Asked Questions about docs-sync-checker

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I detect documentation drift in a repository?

To detect documentation drift, compare filesystem-discovered tools with README and docs entries. This process surfaces missing entries, stale references, and version mismatches across skills, agents, and commands using deterministic reporting.

Can I fail a CI/CD build when documentation is out of sync with tools?

Yes, you can fail CI/CD builds on documentation drift by running the sync checker in strict mode. It generates machine-readable JSON output and actionable remediation guidance for missing or stale entries.

How do I check YAML frontmatter against markdown README files?

Checking YAML frontmatter against markdown README files involves parsing metadata and cross-referencing it with filesystem definitions. This surfaces inconsistencies across skills, agents, and commands during a deterministic scan.

What is the best way to find missing entries in docs for repository tooling?

The best way to find missing entries in docs is running a 4-phase workflow: Scan, Cross-Reference, Detect, and Report. It compares filesystem definitions with documentation to generate precise fixes for missing and stale entries.

Does the documentation sync checker support machine-readable reporting?

Yes, the documentation sync checker supports machine-readable JSON output for CI/CD integration. It applies deterministic reporting to produce actionable issues for version mismatches and documentation drift.

Why does my README show stale entries for commands and agents?

Stale entries in your README occur when filesystem definitions and documentation drift apart. Running a sync checker cross-references markdown tables and lists with actual files to detect and report these inconsistencies.