cross-reference

Analyze Markdown documentation graphs to detect orphaned documents and missing links.

78|252|Updated Feb 7, 2024
One-click install
npx skills add https://github.com/hashicorp/web-unified-docs --skill cross-reference
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cross-reference
Source: https://github.com/hashicorp/web-unified-docs/tree/main/content/well-architected-framework/docs/.claude/skills/cross-reference
Command: npx skills add https://github.com/hashicorp/web-unified-docs --skill cross-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps documentation teams understand how documents relate to each other by visualizing relationships, surfacing orphaned files, and proposing missing connections to improve navigation and discoverability.

Core Features & Use Cases

  • Relationship mapping: builds a graph of internal links to reveal navigation paths.
  • Orphan detection: identifies documents with few or no incoming links.
  • Suggestion generation: proposes logical cross-references to improve discoverability and reading flow.

Quick Start

Identify and map doc relationships for a docs sub-tree to surface relationships and gaps.

Frequently Asked Questions about cross-reference

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

FAQPage Schema
How do I find orphaned markdown documents with no incoming links?

You can identify orphaned markdown documents by analyzing your documentation graph to detect files with zero incoming links. This Skill reads local .mdx and .md files to build a bidirectional link graph and flags isolated content for discoverability optimization.

What is a documentation graph and how does it visualize relationships?

A documentation graph is a bidirectional map of internal links that visualizes how markdown documents relate to each other. It reads local .mdx and .md files to reveal navigation paths and surface missing connections to improve reading flow.

How do I generate missing cross-reference link suggestions for my docs?

To generate missing cross-reference link suggestions, analyze your markdown documentation graph to propose logical connections between documents. This improves discoverability and navigation without requiring any external services.

Do I need any external services or dependencies to map my documentation navigation?

No, you do not need any external services or dependencies to map your documentation navigation. The cross-reference analysis runs entirely on local .mdx and .md files to build the bidirectional link graph.

When should I run a content audit to detect orphaned files in my repository?

You should run a content audit to detect orphaned files when you need to improve documentation discoverability and navigation. Mapping your documentation graph helps identify documents with few or no incoming links during these optimization efforts.

Can I use this to analyze documentation navigation for .mdx files?

Yes, you can analyze documentation navigation for .mdx files. The cross-reference analysis reads local .mdx and .md files across a repository to build a bidirectional graph of internal links and surface missing connections.