smart-cross-reference

Analyze documentation to detect workflow sequences and propose bidirectional links.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Cross-document navigation is often manual, brittle, and hard to scale across large doc ecosystems.

Core Features & Use Cases

  • Workflow detection: automatically identify common workflow sequences across documents.
  • Bidirectional linking: suggest and create two-way links to improve navigation.
  • Orphaned document discovery: locate content with no inbound references for discoverability.
  • Link-strength scoring: quantify connectivity to guide maintenance and improvements.

Quick Start

Use the smart-cross-reference skill to analyze documents and generate cross-reference recommendations.

  • /smart-cross-reference docs/**/*.mdx --full-analysis
  • /smart-cross-reference docs/file.mdx --auto-link --dry-run
  • /smart-cross-reference docs/file.mdx --auto-link --apply
  • /validate-links docs/file.mdx

Frequently Asked Questions about smart-cross-reference

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

FAQPage Schema
How do I automatically find cross-reference opportunities in large documentation collections?

Cross-reference opportunities in large documentation collections are found by applying automated analysis to detect workflow sequences, propose bidirectional links, and locate orphaned documents. This approach scales navigation mapping across entire doc ecosystems.

What is bidirectional linking and how does it improve document navigation?

Bidirectional linking creates two-way connections between related documents, ensuring references point back to each other. This improves document navigation by allowing users to traverse related content seamlessly across large doc ecosystems.

How do I locate orphaned documents with no inbound references?

Orphaned documents with no inbound references are located by scanning the documentation collection for files that are never linked to by others. Discovering these orphans improves content discoverability and highlights gaps in workflow sequences.

Can I preview cross-reference changes before applying them to my documentation?

Yes, you can preview cross-reference changes before applying them by using a dry-run capability. This allows you to review proposed auto-links, bidirectional connections, and workflow detections safely without modifying your documentation files.

What is link-strength scoring and when do I need it for my docs?

Link-strength scoring quantifies document connectivity to guide maintenance and improvements. You need link-strength scoring when managing large doc ecosystems to identify weakly connected files, prioritize updates, and ensure workflow sequences remain highly accessible.

Does auto-linking work for detecting workflow sequences across multiple markdown files?

Auto-linking works for detecting workflow sequences across multiple markdown files by analyzing large documentation collections. It automatically identifies common workflow sequences across documents and proposes bidirectional links to map the entire process.