cross-reference-validation

Validate documentation file paths, links, line numbers, and code imports across repositories and branches.

32|5|Updated Oct 19, 2025
One-click install
npx skills add https://github.com/akaszubski/autonomous-dev --skill cross-reference-validation
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: cross-reference-validation
Source: https://github.com/akaszubski/autonomous-dev/tree/main/plugins/autonomous-dev/skills/cross-reference-validation
Command: npx skills add https://github.com/akaszubski/autonomous-dev --skill cross-reference-validation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

As code evolves, documentation often falls behind, leading to broken file paths, invalid line numbers, and outdated code examples. This "link rot" frustrates developers and wastes time. This skill automatically detects and helps fix these issues, keeping your documentation reliable.

Core Features & Use Cases

  • Link Validation: Checks the existence of internal file paths, Markdown links, and specific file:line references within your documentation.
  • Code Example Verification: Ensures code blocks with imports correctly reference existing exports in your codebase.
  • Git-Aware Fixes: Detects file moves via Git history and suggests auto-fixes for outdated references.
  • Use Case: Before merging a large refactor, run this skill to ensure all documentation references to moved or changed files are updated, preventing future developers from encountering broken links.
  • Use Case: Automatically identify and fix broken links in your README.md or CONTRIBUTING.md files, ensuring new contributors have a smooth onboarding experience.

Quick Start

This skill is typically auto-invoked as part of a larger workflow.

To manually trigger cross-reference validation:

/align-project

(Select Phase 4: Cross-reference validation from the options presented)

Frequently Asked Questions about cross-reference-validation

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

FAQPage Schema
How do I fix broken links and outdated file paths in my documentation?

Cross-reference validation automatically detects broken internal links, invalid file paths, and outdated line-number references in your documentation, then suggests fixes. It scans Markdown files and verifies that all file paths, links, and code examples still point to valid locations in your codebase.

Can I validate code examples and imports in my documentation automatically?

Yes. Code example verification ensures that code blocks with imports correctly reference existing exports in your codebase. This catches outdated imports and missing functions before they frustrate users.

What happens to documentation references when I refactor or move files?

Git-aware validation detects file moves through Git history and automatically suggests updates to outdated references. Before merging large refactors, run validation to ensure all documentation points to renamed or relocated files.

Does this work with documentation repositories and feature branches?

Yes. Cross-reference validation applies to documentation repositories and feature branches where code evolves. It handles relative and absolute link verification, file:line validation, and code block validation across docs and source trees.

Can I automatically update broken references instead of just reporting them?

The Skill provides auto-fix suggestions and supports optional auto-update workflows, allowing you to automatically correct broken links and references rather than fixing them manually.

Why do I need cross-reference validation in my documentation workflow?

As code evolves, documentation often falls behind, creating link rot that frustrates developers and wastes troubleshooting time. Automated validation catches these issues early and keeps your documentation reliable and accurate.