skills.rest
brandonavant
brandonavantCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

cross-reference-check

Scan Markdown files to detect broken internal links and missing chapter entries.

2|1|Updated Mar 15, 2026
Search Tags:#markdown#consistency#validation#cross-reference#link-check#canonical-terms
One-click install
npx skills add https://github.com/brandonavant/harness-engineering-guide --skill cross-reference-check
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: cross-reference-check
Source: https://github.com/brandonavant/harness-engineering-guide/tree/main/.claude/skills/cross-reference-check
Command: npx skills add https://github.com/brandonavant/harness-engineering-guide --skill cross-reference-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Validate repository structure by detecting broken internal links, missing chapter listings, and misaligned references that hinder navigation and reliability.

Core Features & Use Cases

  • Detect broken links and unresolved paths across Markdown files.
  • Validate that every guide chapter is listed in the README and that template references exist.
  • Ensure canonical terms are consistent with referenced registries and files.

Quick Start

Run the cross-reference checker to scan the repository for broken links, missing chapter entries, and structural inconsistencies.

Frequently Asked Questions about cross-reference-check

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

FAQPage Schema
How do I check for broken internal links in my Markdown repository?▼

To identify broken internal links in Markdown files, scan the repository to resolve relative paths and report unresolved references. This process detects broken links across README, CHEATSHEET, and guide chapters to ensure referential integrity.

How do I validate that all guide chapters are listed in the README?▼

Validate guide chapter entries in the README by scanning Markdown files for structural inconsistencies. This checks that every guide chapter has a corresponding entry in the README and that template references exist.

What is cross-reference validation for canonical terms?▼

Cross-reference validation for canonical terms is the process of ensuring terminology consistency across Markdown files. It aligns references with the canonical-terms.md registry to prevent misaligned references and maintain reliable navigation.

Does this cross-reference checker work with Markdown files and relative paths?▼

Yes, the cross-reference checker works with Markdown files by scanning them and resolving relative paths. It validates registry alignment with references/canonical-terms.md to detect unresolved paths and structural inconsistencies.

Why does my Markdown repository have structural inconsistencies and missing chapters?▼

Structural inconsistencies and missing chapters occur when guide chapters lack README entries or template references are unresolved. Scanning Markdown files detects these misaligned references and missing chapter listings to restore referential integrity.

Related Skills

Explore More Software Engineering Skills→
intelli-verse-xintelli-verse-x
1

intelliversex-sdk-roblox

Locate the Roblox SDK directory and documentation within the IntelliVerseX monorepo.

Official
Basic
bordenetbordenet
8

link-verification

Validate and verify Markdown links in documentation before publishing.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate
skill-toolsskill-tools
9

broken-refs

Validate file references in SKILL.md skills and report missing paths.

Official
Intermediate