doc-validator

Validate documentation against type-specific rules and schemas.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/fractary/claude-plugins --skill doc-validator-fractary
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-validator
Source: https://github.com/fractary/claude-plugins/tree/main/plugins/docs/skills/doc-validator
Command: npx skills add https://github.com/fractary/claude-plugins --skill doc-validator-fractary

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, yq, bash, and includes scripts (resource) components.

What problem does it solve?

This Skill validates documentation against dynamic, type-specific rules and schemas.

Core Features & Use Cases

  • Dynamic rule loading: Loads type-specific validation rules
  • Frontmatter + structure checks: Ensures metadata correctness
  • Comprehensive reporting: Returns structured results

Quick Start

Validate a documentation file against its type context.

Frequently Asked Questions about doc-validator

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

FAQPage Schema
How do I validate markdown documentation against custom rules and schemas?▼

Markdown validation checks documents against type-specific rules and schemas loaded dynamically. doc-validator applies frontmatter, structure, content, and link checks by loading rules from types/{doc_type}/validation-rules.md and types/{doc_type}/schema.json, returning structured JSON results for each document.

Can I validate frontmatter metadata in my documentation files?▼

Yes. doc-validator includes dedicated frontmatter validation that enforces metadata correctness against type-specific schemas. It checks frontmatter structure and content validity as part of its comprehensive validation workflow.

What checks does documentation validation cover?▼

Documentation validation encompasses frontmatter metadata checks, document structure validation, content compliance, and link validity. doc-validator orchestrates these checks via specialized scripts and emits structured JSON results for all findings.

How do I set up type-specific validation rules for different document types?▼

Create type-specific rule and schema files in types/{doc_type}/ directories. doc-validator dynamically loads validation-rules.md and schema.json for each document type, allowing you to define custom validation logic per document category.

What output format does documentation validation produce?▼

Validation results are returned as structured JSON, making them machine-readable and easy to parse, integrate into CI/CD pipelines, or display in reports.

Does documentation validation work with markdown and frontmatter together?▼

Yes. doc-validator validates markdown syntax alongside frontmatter metadata, enforcing both content structure and metadata correctness in a single pass per document.