docs-verify

Verify documentation cross-references and canonical definitions, generating a consistency report.

Updated Jan 25, 2026
One-click install
npx skills add https://github.com/Pjpj42/GridRacer --skill docs-verify-pjpj42
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-verify
Source: https://github.com/Pjpj42/GridRacer/tree/main/.claude/skills/docs-verify
Command: npx skills add https://github.com/Pjpj42/GridRacer --skill docs-verify-pjpj42

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation teams struggle to maintain consistency and accuracy across large, evolving doc sets, risking outdated or conflicting information.

Core Features & Use Cases

  • Automated checks for cross-reference validity, duplicate definitions, and canonical references.
  • Generates a concise report highlighting issues, suggested fixes, and a health score for documentation.
  • Use Case: teams maintaining CLAUDE.md and its references across multiple modules.

Quick Start

Run the docs-verify tool at the repository root to produce a consistency report.

Frequently Asked Questions about docs-verify

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

FAQPage Schema
How do I check documentation consistency across a large markdown project?

To check documentation consistency, run an automated verification tool at your repository root to validate cross-references, detect missing files, and find duplicate definitions. This generates a concise report highlighting discrepancies and a health score.

What is documentation cross-reference validation and when do I need it?

Documentation cross-reference validation is the process of checking that internal links and canonical definitions point to existing, correct targets. You need it when maintaining large doc ecosystems to prevent outdated or conflicting information across modules.

How do I find broken links and duplicate definitions in my markdown files?

You can find broken links and duplicate definitions by using file-based verification commands that read and search your project files. These commands identify missing target files and conflicting canonical references, then output a report with suggested fixes.

Can I automate documentation quality checks for a multi-module project?

Yes, you can automate documentation quality checks by running a verification skill at your repository root. It uses bash, read, grep, and glob operations to perform file-based verification, making it suitable for large, multi-module project ecosystems.

What is the best way to maintain alignment between CLAUDE.md and related references?

The best way to maintain alignment is to run automated consistency checks that validate canonical definitions and cross-references against your project files. This ensures your root documentation stays synchronized with related module references.

What are the limitations of automated documentation verification for markdown?

Automated documentation verification relies on file-based checks using bash, read, grep, and glob, limiting it to validating static file references and definitions. It may not detect semantic inconsistencies or runtime-generated content.