broken-reference

Scan Markdown files for broken cross-references and report remediation steps.

17|1|Updated Jun 8, 2025
One-click install
npx skills add https://github.com/williamzujkowski/standards --skill broken-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: broken-reference
Source: https://github.com/williamzujkowski/standards/tree/main/tests/scripts/fixtures/skills/broken-reference
Command: npx skills add https://github.com/williamzujkowski/standards --skill broken-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automatically detects and reports broken internal cross-references within your documentation, preventing users from encountering dead ends and ensuring a smooth navigation experience.

Core Features & Use Cases

  • Link Validation: Scans Markdown files for invalid relative paths and broken links.
  • Integrity Check: Maintains the integrity and navigability of your knowledge base.
  • Use Case: Run this skill on your entire docs/ directory to find all broken links in your SKILL.md files, ensuring all related skills and resources are always accessible.

Quick Start

Scan the attached 'project-docs.md' for any broken cross-references.

Frequently Asked Questions about broken-reference

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

FAQPage Schema
How do I find broken links in my Markdown documentation?

Broken link validation scans your Markdown files for invalid relative paths and dead references. This skill detects broken cross-references in SKILL.md files, identifying which links point to missing or inaccessible targets so you can fix them before users encounter dead ends.

Can I automatically check all cross-references in my docs folder?

Yes. Run this skill on your entire docs directory to scan all SKILL.md files for broken links in See also sections and related Skill references. It produces a complete report of invalid targets with actionable remediation steps for each broken reference.

What does broken link validation actually check?

Link validation examines relative paths, cross-reference targets, and internal documentation links. It verifies that all referenced Skills and resources exist and are correctly linked, maintaining integrity across your knowledge base's reference graph.

How do I ensure my documentation stays navigable?

Integrity checks automatically detect broken internal cross-references that would frustrate users. By running this skill regularly on your docs, you maintain a clean reference graph where all related Skills and resources are always accessible and properly linked.

What's included in the broken link report?

The report identifies each broken cross-reference, shows the invalid target path, and provides actionable remediation steps. This lets you quickly locate problems and fix references to keep your documentation flawless.