Skip to content
Back to skills

Regen Docs

ASecurity

Regenerate the mkdocs-material site, validate cross-references, surface stale or broken links.

  • 5 stars
  • 0 votes
  • 0 copies
  • 2 views
  • Added September 12, 2026
content-marketinggorailsgit

Security analysis

A92/100
  • mediumInstalls packages at runtime which could introduce malicious dependencies

Pro shows the line behind each finding and how to fix it

Scanned September 23, 2026

npx -y skills add VMAFx/vmafx --skill regen-docs --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Regen Docs?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Regen Docs
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/vmafx-regen-docs/badge)](https://www.skillsdirectory.com/skills/vmafx-regen-docs)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: regen-docs
description: Regenerate the mkdocs-material site, validate cross-references, surface stale or broken links.
---
<!-- markdownlint-disable MD013 -->

# /regen-docs

## Invocation

```text
/regen-docs [--strict] [--open]
```

## Steps

1. Verify tools:
   - `mkdocs --version`, confirm `mkdocs-material` theme on venv.
   - Bail with install hints if missing (`pip install mkdocs mkdocs-material`).
2. Run `mkdocs build --strict` from repo root. Site config = `mkdocs.yml`;
   output lands under `build-docs/site/`.
   - `--strict` fails build on any warning (broken link, missing nav target,
     etc.).
3. Surface broken cross-refs:
   - mkdocs-material emits `INFO`-level "not found / unrecognized" messages
     for ADR / research / source-tree refs that don't resolve. Capture
     `/tmp/mkdocs_build.log`, grep for `INFO` lines.
   - Categorise: (a) source-tree refs (`../../core/...`) — inherently
     unresolvable from mkdocs site; expected. (b) doc-to-doc refs — actionable
     drift, mostly ADR slug renames.
4. Validate ADR coherence:
   - Every `docs/adr/NNNN-*.md` has index row in `docs/adr/README.md`.
   - Every `(adr/NNNN-slug.md)` ref in `docs/state.md` / `docs/rebase-notes.md`
     points at actual on-disk filename for that NNNN.
5. Diff generated site against previous run (`git diff --no-index` on
   `build-docs/site/`); flag suspicious deletions.
6. If `--open`: open `build-docs/site/index.html` in user browser.
7. Print summary: build status, broken-link count (split by category), pages
   added/removed.

## Guardrails

- `--strict` fails skill on any mkdocs warning.
- Never edits doc sources — only regenerates output, surfaces drift. If
  ADR slugs drifted (concept-stable but filename evolved), open separate
  scoped repair PR — don't bulk-rewrite as side effect.
- 5-point ADR-0042 tiny-AI doc bar and per-surface ADR-0100 bars independent
  of regen-docs — skill verifies *coherence*, not *substance*.

## Notes

- Legacy Doxygen + Sphinx setup retired around 2026-04-30 in favour of
  mkdocs-material. `Doxyfile.in` at `core/doc/Doxyfile.in` survives but not
  wired into build target.
- mkdocs `INFO` messages **not** promoted to warnings under `--strict` by
  default. To make doc-to-doc drift fatal, set
  `validation.unrecognized_links: warn` in `mkdocs.yml`.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…

Newsletter

Get the weekly list of safe new skills, and the ones we pulled.