docs-validator

Validate frontmatter, links, READMEs, and changelogs in documentation.

Updated Dec 13, 2025

Search Tags:#changelog #documentation #validation #quality #frontmatter #link-check #readmes

Ready to run

npx skills add https://github.com/gaurangrshah/gsc-plugins --skill docs-validator-gaurangrshah

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-validator
Source: https://github.com/gaurangrshah/gsc-plugins/tree/main/plugins/docs/skills/docs-validator
Command: npx skills add https://github.com/gaurangrshah/gsc-plugins --skill docs-validator-gaurangrshah

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Proactive documentation QA helps teams maintain accurate frontmatter, verify link integrity, keep READMEs up to date, and ensure changelogs are current, reducing knowledge gaps and deployment risks.

Core Features & Use Cases

Validate YAML frontmatter across docs, including required fields like title, type, and created dates.
Check internal and external links for broken paths, orphaned files, and correct references in READMEs.
Enforce README completeness, track changelog sections, and generate a concise validation report.
Monthly hygiene, pre-release checks, and integration with docs-management workflows to surface issues before they impact users.

Quick Start

Run the documentation-validation skill to scan your docs root, perform frontmatter, link, and changelog checks, and produce a validation report for review.

Frequently Asked Questions about docs-validator

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

FAQPage Schema

How do I validate YAML frontmatter across my documentation files?▼

Validate YAML frontmatter by scanning your docs root to enforce required fields like title, type, and created dates. The skill checks frontmatter presence and formats, producing a structured validation report for review.

What's the best way to check for broken links and orphaned files in READMEs?▼

Check for broken links by scanning internal and external paths, detecting orphaned files, and verifying correct references in READMEs. The skill performs link integrity checks to surface issues before they impact users.

How do I automate changelog completeness checks before a major release?▼

Automate changelog completeness checks by running the validation skill during pre-release workflows. It tracks changelog sections, enforces README coverage, and generates a concise validation report to catch issues early.

Can I use documentation validation for monthly hygiene cycles without additional dependencies?▼

Use documentation validation for monthly hygiene cycles without additional dependencies. The skill operates independently to perform frontmatter, link, and changelog checks, producing a structured report for review.

Why does my documentation QA workflow need frontmatter validation and link checking together?▼

Documentation QA needs frontmatter validation and link checking together to maintain accurate metadata, verify link integrity, and reduce knowledge gaps and deployment risks. Combining these checks ensures comprehensive coverage across docs.

When should I run documentation validation to catch issues early in my workflow?▼

Run documentation validation during monthly hygiene cycles, before major releases, and within docs-management workflows. The skill proactively surfaces frontmatter, link, and changelog issues, producing a structured validation report.