validate-links

Validate cross-links across markdown files, schemas, and index coverage.

5|Updated Mar 14, 2026
One-click install
npx skills add https://github.com/romamo/cli-agent-spec --skill validate-links-romamo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: validate-links
Source: https://github.com/romamo/cli-agent-spec/tree/main/.claude/skills/validate-links
Command: npx skills add https://github.com/romamo/cli-agent-spec --skill validate-links-romamo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Validate and ensure the integrity of cross-links across the project docs, schemas, and requirements by detecting broken links and missing references.

Core Features & Use Cases

  • Broken-link detection across all markdown files.
  • Schema ↔ requirement symmetry checks to ensure proper back-links.
  • Index coverage validation for requirements and schemas.
  • Content completeness auditing to surface incomplete documentation.
  • Counter consistency verification to align counts with on-disk files.

Quick Start

Run the five validation scripts in order from the repo root to report all failures and a summary of checks performed.

Frequently Asked Questions about validate-links

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

FAQPage Schema
How do I check for broken links in markdown documentation?

Broken link detection in markdown files works by cross-referencing internal links against actual file paths on disk. It identifies missing referenced files and reports them as failures, ensuring all internal markdown documentation links resolve correctly.

How do I validate back-link symmetry between schemas and requirements?

Back-link symmetry validation checks that schema and requirement markdown files reference each other correctly. It verifies that if a schema links to a requirement, the corresponding requirement file also links back to that schema.

What is the best way to ensure index completeness for markdown docs?

Index completeness validation ensures all markdown requirements and schemas are properly listed in the project's index files. It audits the index coverage to surface any documents that are missing from the central registry.

Can I automate documentation consistency checks across a markdown project?

Yes, you can automate documentation consistency by running validation scripts from the repository root. These scripts execute five core checks including content completeness and counter consistency, reporting all failures and a summary of checks performed.

Why does my documentation counter not match the files on disk?

Counter consistency verification aligns documented file counts with actual on-disk files in your markdown project. If the counters do not match, the validation scripts will report a failure indicating that the tracked counts need updating.