Name: doc-consistency-check
Author: yeaight7

Imported from yeaight7/agent-powerups (plugins/documentation-systems/skills/doc-consistency-check/SKILL.md). Install upstream with npx skills add yeaight7/agent-powerups --skill doc-consistency-check. Copyright stays with the author.

Purpose

Documentation rots when code changes. This check finds stale references in Markdown files — paths, commands, package scripts, env names, links — and flags them for immediate correction.

When to Use

After a refactor that renamed or moved files, scripts, or env vars
A reader followed the docs and a command or path failed
Periodic doc hygiene before a release

Inputs

The documentation set (Markdown files across the repo, not just the README)
The current repo state to validate against

Workflow

Inventory the docs and extract referenced paths:

git ls-files "*.md"                                                      # full doc inventory
rg -no "[A-Za-z0-9_-]+/[A-Za-z0-9_./-]+\.[a-z]{2,4}" README.md docs/    # path-like references

Verify referenced files still exist in the repository. If not, the documentation is stale:
```
test -f src/components/Button.tsx || echo "STALE: src/components/Button.tsx"
```

Verify documented commands against reality. Package scripts, CLI invocations, and env names must match the current source:

rg -no "npm run [a-z:-]+" README.md docs/ | sort -u    # documented scripts...
rg -n "\"scripts\"" -A 20 package.json                 # ...vs actual scripts
rg -no "[A-Z][A-Z0-9_]{3,}=" docs/ | sort -u           # documented env names vs config source

Check code blocks in documentation. Do the function names and variable names still match the actual source code?
```
rg -n "functionNameFromDocs" src/ || echo "identifier not found in source"
```
Check links. Relative links must resolve to existing files; flag external links that obviously moved.
Flag everything for immediate correction. Fix in place when the right value is unambiguous; report the rest with file and line.

Output

A stale-reference report grouped by type (paths, commands, scripts, env names, links), each with doc file:line
Fixes applied where the correct replacement is unambiguous

Verification

All Markdown files inventoried, not just the README
Every doc-referenced path tested for existence
Documented scripts and commands compared against the actual manifest/CLI
Code-block identifiers spot-checked against source
Each finding fixed or reported with file and line

Failure Modes

README-only pass — the rot usually lives in docs/ and subsystem files, not the front page.
Existence-only checking — a path can exist while the command or identifier on the same line is stale.
Guessed fixes — when the correct replacement is ambiguous, report it; do not invent one.

Install doc-consistency-check and it becomes one more candidate the router can pick - when it fits.

A listing is a routing target with a manifest: what it does, which domains it covers, what it costs and who publishes it. Once installed it sits beside your own models and tools, is scored like any other candidate for each request, and shows up in the trace when it wins. Ratings come from workspaces that installed it, one per account.

{ "ocm": "1", "id": "yeaight7-agent-powerups-doc-consistency-check", "kind": "skill", "name": "doc-consistency-check", "description": "Use when documentation may have rotted against the code -- files were renamed or moved, scripts or env vars changed, or readers report commands and paths from the docs that no longer work.", "publisher": "yeaight7", "version": "1.0.0", "capabilities": { "domains": [ "coding" ], "tags": [ "skill-md", "github" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Use when documentation may have rotted against the code -- files were renamed or moved, scripts or env vars changed, or readers report commands and paths from the docs that no longer work." ], "primary": false, "metadata": { "source": { "provider": "github", "repository": "https://github.com/yeaight7/agent-powerups", "path": "plugins/documentation-systems/skills/doc-consistency-check/SKILL.md", "ref": "46cd150c619c266cd2a591dc60cc1d0d6257b6b5", "url": "https://github.com/yeaight7/agent-powerups/blob/46cd150c619c266cd2a591dc60cc1d0d6257b6b5/plugins/documentation-systems/skills/doc-consistency-check/SKILL.md", "key": "yeaight7/agent-powerups/plugins/documentation-systems/skills/doc-consistency-check/SKILL.md" } }, "instructions": "## Purpose\n\nDocumentation rots when code changes. This check finds stale references in Markdown files — paths, commands, package scripts, env names, links — and flags them for immediate correction.\n\n## When to Use\n\n- After a refactor that renamed or moved files, scripts, or env vars\n- A reader followed the docs and a command or path failed\n- Periodic doc hygiene before a release\n\n## Inputs\n\n- The documentation set (Markdown files across the repo, not just the README)\n- The current repo state to validate against\n\n## Workflow\n\n1. **Inventory the docs and extract referenced paths:**\n\n ```bash\n ", "cost": { "context_tokens": 674 } }

doc-consistency-check

About

Purpose

When to Use

Inputs

Workflow

Output

Verification

Failure Modes

Install doc-consistency-check and it becomes one more candidate the router can pick - when it fits.

Use it

Manifest

Reviews