docs-testing
Installation
SKILL.md
docs-testing Skill
Part 1: Decision Table — What to Run
Identify the changed file type and run the corresponding commands. Pre-commit hooks run automatically; "Run locally" items require manual invocation before or after committing.
| Changed file | Pre-commit (auto) | Run locally | CI (auto on PR) |
|---|---|---|---|
content/**/*.md |
Vale, markdown checks | yarn lint-codeblocks <files> · link-checker map+check |
Vale, link-checker, codeblock lint |
content/shared/**/*.md |
Vale (via product globs) | Same as content. Also find consuming products: grep -r "source:.*<filename>" content/ |
Same |
layouts/**/*.html |
render-hook whitespace (if render hook) | node cypress/support/run-e2e-specs.js --spec cypress/e2e/... --no-mapping |
pr-render-check, Cypress (if layout/asset changed) |
assets/js/*.ts |
TypeScript build (auto-staged) | — | — |
assets/**/*.{js,mjs,css,scss} or layouts/*.html or content/example.md |
prettier, eslint | (pre-push auto) Cypress shortcode examples | pr-render-check |
data/products.yml |
build-agent-instructions, check-feedback-links | — | pr-feedback-links |
api-docs/**/*.yml |
— | yarn build:api-docs then Cypress for affected pages |
— |
*.sh |
shellcheck | — | — |
README.md, DOCS-*.md, AGENTS.md, CLAUDE.md, .github/**/*.md, .claude/**/*.md |
remark (auto-fixed), Vale (instructions config) | — | pr-remark-check |
lefthook.yml, .github/workflows/*.yml |
— | Manual review | — |
scripts/** or layouts/index.llmstxt.txt or scripts/lib/corpus-paths.js |
— | yarn build:ts && npx hugo --quiet && yarn build:md && yarn check:md-coherence |
— |