regen-docs

Rebuild mkdocs-material sites and detect broken links and ADR drift.

3|1|Updated May 28, 2026
One-click install
npx skills add https://github.com/VMAFx/vmafx --skill regen-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: regen-docs
Source: https://github.com/VMAFx/vmafx/tree/main/.claude/skills/regen-docs
Command: npx skills add https://github.com/VMAFx/vmafx --skill regen-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill rebuilds the documentation site and exposes broken links, stale references, and ADR drift before they reach readers.

Core Features & Use Cases

  • Regenerates the mkdocs-material site from the repository root with strict validation enabled.
  • Surfaces actionable doc-to-doc cross-reference issues while ignoring expected source-tree references that cannot resolve inside the site.
  • Checks ADR index coherence and filename consistency, then compares the new site output with the previous run to spot suspicious deletions.
  • Use it when you need a safe documentation quality gate, a release-readiness check, or a quick audit of broken navigation.

Quick Start

Ask the assistant to regenerate the documentation site in strict mode and report any broken links, ADR mismatches, and suspicious page removals.

Frequently Asked Questions about regen-docs

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

FAQPage Schema
How do I detect broken cross-references in an mkdocs-material documentation site?

To detect broken cross-references in an mkdocs-material site, rebuild the documentation with strict validation enabled. This surfaces actionable doc-to-doc cross-reference issues while ignoring expected source-tree references that cannot resolve inside the site.

What is ADR drift and how do I check ADR index coherence?

ADR drift occurs when architecture decision records fall out of sync with repository filenames. You check ADR index coherence by running a validation process that verifies filename consistency and matches the ADR index against actual repository contents.

How do I validate documentation links before a release readiness check?

Validate documentation links before a release readiness check by regenerating your site with strict build validation. This process catches stale links and broken navigation, then compares the new output with the previous build to spot suspicious page deletions.

Can I use this to find stale links and suspicious page removals in my docs?

Yes, you can find stale links and suspicious page removals by comparing new site output against the previous run. This output diff comparison highlights unexpected deletions and stale references before they reach readers.

Why does my documentation site build ignore source-tree references during link validation?

Documentation site builds ignore source-tree references during link validation because those references point to repository source files rather than site pages. The validation process specifically targets doc-to-doc cross-reference issues that can resolve inside the generated site.

What is the best way to catch link drift in repository maintenance workflows?

The best way to catch link drift in repository maintenance is to run a documentation quality gate that categorizes link drift and enforces strict build validation. This exposes broken links and stale references during local site regeneration.