docs-check

Validate docmd-built documentation sites through build, orphan, ADR index, and LLM output checks.

Updated Apr 9, 2014
One-click install
npx skills add https://github.com/thoroc/thoroc.github.io --skill docs-check-thoroc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-check
Source: https://github.com/thoroc/thoroc.github.io/tree/main/.agents/skills/docs-check
Command: npx skills add https://github.com/thoroc/thoroc.github.io --skill docs-check-thoroc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @docmd/core, and includes references (resource) components.

What problem does it solve? Documentation sites silently degrade through broken builds, orphan pages invisible to navigation, stale ADR indexes, and missing LLM output files. This Skill provides a repeatable validation gate that catches these issues before they reach production and erode reader trust. ## Core Features & Use Cases - Build Verification: Runs npx @docmd/core build first to catch broken links, invalid frontmatter, and missing files, with a page-count sanity check to detect silently dropped content. - Orphan Page Detection: Uses shell commands (find, rg, comm) to find markdown pages not linked from any index, then fixes the source index rather than the ephemeral build output. - ADR Index Reconciliation: Compares docs/ADR/adr-*.md files against docs/ADR/index.yaml in both directions, flagging unregistered ADRs and stale entries pointing at deleted files. - LLM Output Audit: Verifies llms.txt, llms-full.txt, and llms.json exist in the build output when llms.enabled is true in docmd.config.json. - Use Case: After adding a new architecture page, run this Skill before pushing to confirm the build passes, the page is linked from docs/index.md, and the site is ready for CI deployment. ## Quick Start Check the docs are in good shape before I push my changes to the documentation site.

Frequently Asked Questions about docs-check

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

FAQPage Schema
How do I check a docmd documentation site before deploying?▼

Run npx @docmd/core build first to confirm the site compiles, then check for orphan pages, reconcile the ADR index, audit LLM output files, and preview with npx @docmd/core dev before pushing to main.

How to find orphan pages in a markdown documentation site?▼

List all markdown files under docs/ with find, extract linked references from docs/index.md using rg, then compare the two sorted lists with comm -23. Any file in the output is unreachable from navigation and needs an index link.

Why does my docmd build fail with an ENOENT error?▼

An ENOENT error means a referenced file is missing, usually a broken link after a file rename. Read the error path to find the source markdown file and line, fix the link target in the source, and re-run the build to confirm exit code 0.

Why are llms.txt files missing after a successful docmd build?▼

If llms.enabled is true in docmd.config.json but llms.txt, llms-full.txt, and llms.json are absent from site/, the config may not be picked up or the docmd version may not support the feature. Check the config wiring and docmd version rather than treating build success as proof.

When should I not use this documentation validation workflow?▼

Skip it for content quality or style review of individual pages, which belongs to markdown-authoring, and for reviewing SKILL.md files, which belongs to skill-quality-auditor. For trivial typo fixes, the build check can be skipped unless CI is already broken.