docs-validating-links

Validate markdown links for internal paths, external URLs, and formatting compliance.

3|1|Updated Apr 18, 2026
One-click install
npx skills add https://github.com/wahidyankf/ose-primer --skill docs-validating-links
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-validating-links
Source: https://github.com/wahidyankf/ose-primer/tree/main/.claude/skills/docs-validating-links
Command: npx skills add https://github.com/wahidyankf/ose-primer --skill docs-validating-links

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Broken markdown links break user navigation, reduce documentation credibility, and are difficult to locate manually in large repositories.

Core Features & Use Cases

  • Internal Link Validation: Checks for correct relative paths, required .md extensions for documentation files, and absence of unsupported wiki-link syntax.
  • External Link Verification: Validates HTTP/HTTPS URL accessibility with cached results to minimize redundant network requests.
  • Use Case: For teams maintaining multi-file documentation sets, use this skill to build a checker that scans all markdown files for broken links, formatting errors, and inaccessible external resources before merging changes.

Quick Start

Use the docs-validating-links skill to scan all markdown files in the docs/ directory for broken internal and external links.

Frequently Asked Questions about docs-validating-links

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

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

To check for broken markdown links, scan all markdown files in directories like docs/ to validate internal relative paths, enforce .md extensions, and verify external URL HTTP status accessibility. This detects formatting errors and inaccessible resources before merging documentation changes.

What is external URL verification for markdown files?

External URL verification validates HTTP and HTTPS accessibility for links inside markdown files. It applies cached validation results to minimize redundant network requests, ensuring external resources remain accessible and documentation credibility stays intact.

How do I detect unsupported wiki-link syntax in markdown documentation?

Detect unsupported wiki-link syntax by scanning markdown files for formatting compliance. Validation workflows check internal documentation paths for correct relative links and required .md extensions, flagging any wiki-link syntax that degrades navigation.

Can I validate internal documentation paths across multiple directories?

Yes, you can validate internal documentation paths across docs/, repo-governance/, and plans/ directories. The validation checks link existence, enforces .md extensions for documentation files, and ensures relative paths resolve correctly across multi-file documentation sets.

Why does broken link detection matter for documentation quality?

Broken link detection matters because broken markdown links degrade documentation usability and user navigation. Locating malformed links manually in large repositories is difficult, so automated validation ensures formatting compliance and external accessibility before shipping.

What's the best way to scan markdown files for broken links before merging?

The best way to scan markdown files before merging is to run a validation checker across directories like docs/ and plans/. This verifies internal path existence, enforces .md extensions, checks external HTTP status, and stores cached validation results.