Skip to content

notque/vexjoy-agent / skills/meta/docs-sync-checker

docs-sync-checker

Verified

Detect documentation drift against filesystem state.

FileKindSize
SKILL.mdskill md11.6 KB
references/documentation-structure.mdmarkdown3.0 KB
references/integration-guide.mdmarkdown2.8 KB
references/sync-rules.mdmarkdown2.1 KB
scripts/generate_report.pyexecutablescript10.4 KB
scripts/parse_docs.pyexecutablescript10.9 KB
scripts/scan_tools.pyexecutablescript14.1 KB
scripts/validate.pyexecutablescript8.2 KB

references/integration-guide.md

View on GitHub
# Integration Guide

How the docs-sync-checker pipeline runs, its output, and which CI checks already cover the same ground.

## Pipeline

```bash
python3 skills/meta/docs-sync-checker/scripts/scan_tools.py --repo-root . --output /tmp/scan.json
python3 skills/meta/docs-sync-checker/scripts/parse_docs.py --repo-root . --scan-results /tmp/scan.json --output /tmp/issues.json
python3 skills/meta/docs-sync-checker/scripts/generate_report.py --issues /tmp/issues.json --scan-results /tmp/scan.json --output /tmp/sync-report.md
```

| Script | Exit 0 | Exit 1 | Exit 2 |
|--------|--------|--------|--------|
| `scan_tools.py` | Scan done | Repo root missing, or YAML and name errors | Unexpected error |
| `parse_docs.py` | No issues | Missing or stale entries | Error, including a missing primary doc |
| `generate_report.py` | Report written | `--strict` and issues found | Error |

`hooks/posttool-docs-drift-alert.py` runs `scan_tools.py` after edits; keep its exit-code contract stable.

## Filter by tool type

```bash
python3 skills/meta/docs-sync-checker/scripts/scan_tools.py --repo-root . --types skills
python3 skills/meta/docs-sync-checker/scripts/scan_tools.py --repo-root . --types agents,commands
```

## JSON output

```bash
python3 skills/meta/docs-sync-checker/scripts/generate_report.py --issues /tmp/issues.json --format json --output report.json
```

```json
{
  "generated_at": "2026-01-01T00:00:00Z",
  "summary": {"missing_entries": 0, "stale_entries": 0, "total_issues": 0},
  "issues": {"missing_entries": [], "stale_entries": [], "incomplete_entries": []},
  "report_version": "1.0.0",
  "scan_summary": {}
}
```

Each issue carries `suggested_fix`: a generator command for `docs/skills.md` and `docs/routing-map.md`, or the exact row to add or remove in `docs/REFERENCE.md`.

## CI coverage

CI (`.github/workflows/test.yml`) does not run this skill. It runs the authoritative checks directly:

| Check | Catches |
|-------|---------|
| `python3 scripts/generate-skills-doc.py --check` | `docs/skills.md` out of date |
| `python3 scripts/generate-routing-map.py --check` | `docs/routing-map.md` out of date |
| `python3 scripts/validate-index-integrity.py` | Index entries pointing at missing files |
| `python3 scripts/validate-doc-links.py` | Broken doc links |
| `python3 scripts/validate-doc-counts.py` | Wrong count claims in docs |
| `python3 scripts/validate-doc-commands.py` | Scripts named in docs that do not exist |
| `python3 scripts/docs-catalog.py --check` | `docs/*.md` missing `summary` or `read_when` |

The commands-to-`docs/REFERENCE.md` comparison is the one check only this skill makes.

## Pull request checklist

```markdown
- [ ] Ran docs-sync-checker; 0 missing, 0 stale
- [ ] Regenerated docs/skills.md and docs/routing-map.md after component changes
- [ ] Added or removed the docs/REFERENCE.md row for any new or deleted command
```
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 197kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 197kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 197kUpdated Claude CodeCodexVerifiedInstall