docs-crosslink-validator

Validate cross-links in Elastic documentation markdown files and report broken links.

71|10|Updated Aug 20, 2025
One-click install
npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-crosslink-validator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-crosslink-validator
Source: https://github.com/elastic/elastic-docs-skills/tree/main/skills/review/crosslink-validator
Command: npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-crosslink-validator

SYSTEM DOCUMENTATION & REQUIREMENTS

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

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.

Frequently Asked Questions about docs-crosslink-validator

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

FAQPage Schema
How do I validate cross-links in markdown documentation files?

This Skill validates cross-links by extracting URIs from markdown files and resolving them against published documentation data to report broken links with detailed file paths and line numbers.

Can I check internal documentation links before publishing a new version?

Yes, you can verify internal documentation links before publishing by running this Skill against your markdown directory to automatically verify that all cross-references point to valid pages and anchors.

How does link resolution work for Elastic documentation cross-references?

Link resolution for Elastic documentation cross-references works by fetching published documentation data via an MCP tool or web fetch to verify if the target of each extracted cross-link actually exists. It handles various link formats and reports suspicious links with detailed error information.

What is the best way to find broken markdown cross-links in a docs directory?

The best way to find broken markdown cross-links is to use an automated validation skill that extracts repository URIs and checks them against published data, generating a clear report of valid and broken links with file paths and line numbers.

What error information is provided when documentation cross-link validation fails?

When documentation cross-link validation fails, it reports broken or suspicious links with detailed error information including the specific file paths and line numbers where the invalid cross-references were found.

Do I need external dependencies to validate documentation cross-links?

No external dependencies are required to validate documentation cross-links, as this Skill operates independently using scripts and references to extract URIs and fetch published documentation data for resolution.