Stats
Actions
Tags
From docs
Run documentation validation checks for frontmatter, links, and structure compliance
How this command is triggered — by the user, by Claude, or both
Slash command
/docs:docs-validateThe summary Claude sees in its command listing — used to decide when to auto-load this command
# /docs-validate Run documentation validation checks. ## Usage ## Options - `--quick` - Fast validation (frontmatter + obvious issues only) - `--path <dir>` - Validate specific directory (default: `$DOCS_ROOT`) - `--fix` - Attempt to auto-fix simple issues - `--report` - Generate detailed report to `/tmp/docs-validation-YYYY-MM-DD.md` ## What It Checks ### Quick Mode (`--quick`) - Frontmatter exists on all .md files - Required fields present (title, type, created) - No obvious broken links - ~1-2 minutes ### Full Mode (default) - All quick mode checks - Internal link validation - R...
Run documentation validation checks.
/docs-validate [options]
--quick - Fast validation (frontmatter + obvious issues only)--path <dir> - Validate specific directory (default: $DOCS_ROOT)--fix - Attempt to auto-fix simple issues--report - Generate detailed report to /tmp/docs-validation-YYYY-MM-DD.md--quick)| Category | Severity | Example |
|---|---|---|
| Missing frontmatter | Critical | File has no --- block |
| Broken link | Critical | Link to non-existent file |
| Missing required field | Warning | No created date |
| Orphaned file | Warning | Not referenced in README |
| Missing README | Warning | Subdirectory without README.md |
| Stale content | Info | Not updated in 90+ days |
Quick validation before commit:
/docs-validate --quick
Full validation with report:
/docs-validate --report
Validate specific directory:
/docs-validate --path ~/docs/security
Auto-fix simple issues:
/docs-validate --fix
Console output:
📋 Documentation Validation Report
Checked: 42 files
Issues: 3 critical, 5 warnings, 2 info
❌ Critical Issues:
- security/new-policy.md: Missing frontmatter
- guides/README.md: Broken link to old-guide.md
⚠️ Warnings:
- 5 files not referenced in READMEs
ℹ️ Info:
- Consider adding tags to 2 files
Full report: /tmp/docs-validation-2025-01-15.md
When --fix is used:
| Issue | Auto-Fix Action |
|---|---|
| Missing frontmatter | Add minimal frontmatter template |
| Missing created date | Add today's date |
| Malformed date | Convert to YYYY-MM-DD |
Note: Auto-fix creates backups before modifying files.
If worklog plugin is configured, validation results are logged:
INSERT INTO entries (agent, task_type, title, details, outcome, tags)
VALUES ('hostname', 'validation', 'Docs validation', 'details', 'outcome', 'docs,validation');
| Frequency | Mode | When |
|---|---|---|
| Per commit | --quick | Before git commit |
| Weekly | Full | During review |
| Monthly | Full + --report | First of month |
npx claudepluginhub gaurangrshah/gsc-plugins --plugin docs/doctorDiagnoses documentation health across structure, files, content, and navigation; reports categorized issues and optionally auto-fixes or interactively confirms changes.
/healthRuns unified documentation health analysis detecting stale docs, broken links, version drift, and cross-document inconsistencies. Supports modes like scan, links, check <path>, drift, and setup.
/allValidates tool usage, documentation consistency, cross-references, best practices, and execution flow, producing a score, prioritized findings, and detailed report.