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)