docs-crosslink-validator

Official

Validate documentation cross-links.

Authorelastic
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill ensures the integrity of internal documentation links, preventing broken navigation and improving user experience by identifying and reporting invalid cross-references.

Core Features & Use Cases

  • Cross-link Extraction: Identifies links using the repository://path.md format within markdown files.
  • Link Resolution: Verifies if the target of each cross-link exists using an MCP tool or web fetching.
  • Reporting: Generates a clear report of valid and broken links, including file paths and line numbers for errors.
  • Use Case: When preparing to publish a new version of the documentation, use this skill to automatically check all internal links to ensure they point to valid pages and anchors.

Quick Start

Validate all cross-links in the 'docs/reference' directory.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: docs-crosslink-validator
Download link: https://github.com/elastic/elastic-docs-skills/archive/main.zip#docs-crosslink-validator

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.