documentation-validation
Use when the user wants to validate documentation quality, check for broken links, lint prose or Markdown, test code examples, verify setup instructions, or set up CI for documentation testing. Covers prose linting with Vale, Markdown/RST syntax checking (markdownlint, doc8), link validation (HTMLProofer, lychee, markdown-link-check), code example testing (pytest doctest, cargo test --doc), notebook validation (nbval), container-based instruction testing, and GitHub Actions CI integration for research software projects. Trigger phrases: check my docs, broken links, doc quality, documentation errors, spelling/grammar in docs, test documentation, validate README, link check, prose linting, doc CI.
Pinned to revision 1bca4bbdf059, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/documentation-validation/SKILL.md
- skills/documentation-validation/assets/vale-config.ini
- skills/documentation-validation/assets/validation-checklist.md
- skills/documentation-validation/references/documentation-standards.md
- skills/documentation-validation/references/vale-configuration.md
- skills/documentation-validation/references/validation-tools.md
Every link opens the file at its source, pinned to the revision this page describes.