wf-doc-lint

Detects broken code references, dead links, and structural drift in project documentation.

Updated May 9, 2026
One-click install
npx skills add https://github.com/23min/aiwf --skill wf-doc-lint-23min
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: wf-doc-lint
Source: https://github.com/23min/aiwf/tree/main/internal/skills/embedded-rituals/plugins/wf-rituals/skills/wf-doc-lint
Command: npx skills add https://github.com/23min/aiwf --skill wf-doc-lint-23min

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation drifts out of sync with code as projects evolve: symbols get renamed, features get removed, links break, and CLI flags change, but nobody notices until a reader hits a dead end. This Skill runs a mechanical, read-only lint over the narrative docs tree and reports every drift finding with path:line locations, without rewriting any prose. ## Core Features & Use Cases - Seven mechanical checks: broken code references, removed-feature docs, orphan files, documentation TODOs, markdown link integrity (including anchors), stale CLI invocations verified against the tool's real help output, and structural issues like table-of-contents drift and heading-hierarchy skips. - Scoped or full runs: lint the entire docs root plus hand-authored root files like README.md, or scope the run to docs intersecting a specific change-set before a merge. - Report-only output: emits a structured markdown report with findings grouped by check type; it never modifies, deletes, or auto-fixes any file. - Use Case: After a refactor that renamed several functions and removed a CLI flag, run the lint before proposing the change for merge to catch every doc that still references the old names. ## Quick Start Run a doc lint over the docs directory and README to report broken code references, dead links, and stale CLI invocations before I merge this change.

Frequently Asked Questions about wf-doc-lint

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

FAQPage Schema
How do I check documentation for broken code references?

Run a doc lint that walks every markdown file, extracts referenced symbols like function names, file paths, and config keys, and verifies each exists in the current source tree. Findings are reported with path:line so you can locate and fix each stale reference manually.

How to find broken markdown links in a docs folder?

A markdown link check resolves three link shapes: relative file links, cross-document heading anchors, and links into source files. Anchors are matched by slugifying headings (lowercase, spaces to hyphens, punctuation stripped), and links inside code spans or fenced blocks are skipped as prose.

Can a linter detect stale CLI commands in documentation?

Yes, by comparing backticked invocations of the project's own CLI against the tool's real command surface obtained from its help output, recursing into subcommand help. Docs discussing deferred or hypothetical verbs are treated as intentional, not drift.

Does doc linting modify or auto-fix my documentation files?

No. This lint is strictly report-only: it never rewrites prose, deletes orphan files, or fixes links, even for mechanical-looking changes. Every finding is surfaced for human review, and the report is the entire output with no side-effect writes.

When should I not use a documentation drift lint?

It does not judge content quality, prose clarity, or semantic alignment between docs and code, and it does not enforce freshness thresholds. Generated files, changelogs, and working TODO files are excluded from scope since lint findings there would be false positives.