xh-update-doc-links

Synchronize and validate project documentation links and indexes.

31|11|Updated Jan 16, 2018
One-click install
npx skills add https://github.com/xh/hoist-react --skill xh-update-doc-links
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: xh-update-doc-links
Source: https://github.com/xh/hoist-react/tree/main/.claude/skills/xh-update-doc-links
Command: npx skills add https://github.com/xh/hoist-react --skill xh-update-doc-links

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill ensures that all documentation links, indexes, and registries within the project are consistent and up-to-date, preventing broken links and outdated information.

Core Features & Use Cases

  • Automated Link Validation: Checks for broken internal markdown links across all documentation files.
  • Index Synchronization: Keeps docs/README.md and docs/planning/docs-roadmap.md in sync with the actual documentation files on disk.
  • Registry Management: Updates docs/doc-registry.json to reflect the current state of documentation.
  • Cross-linking Enhancement: Identifies and adds new contextual links to related documentation.
  • Use Case: After adding a new component's README, this Skill automatically adds it to the main documentation index, updates the roadmap, validates any new links within it, and suggests cross-links from existing concept documents.

Quick Start

Run the xh-update-doc-links skill to synchronize all project documentation.

Frequently Asked Questions about xh-update-doc-links

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

FAQPage Schema
How do I validate internal markdown links across project documentation?

You can validate internal markdown links by running this Skill to automate link validation, which scans documentation files to detect and report broken cross-references. It ensures documentation consistency by reconciling on-disk files with central index files.

What is the best way to sync a docs README index with actual files on disk?

The best way to sync a docs README index is using an automated synchronization process that reconciles on-disk files with index files. This Skill updates docs/README.md and docs/planning/docs-roadmap.md to match your current documentation structure.

How does cross-linking enhancement work for related documentation?

Cross-linking enhancement works by analyzing related documentation content to identify and automatically add new contextual links between concept documents. This improves navigation across the project and ensures inter-document references remain connected.

Can I use this documentation sync tool with a central document registry?

Yes, you can use this tool with a central document registry to maintain accurate records. It updates docs/doc-registry.json to reflect the current state of documentation, ensuring all entries match the actual files on disk.

Does automated index synchronization work for the Hoist React framework?

Yes, automated index synchronization is designed specifically for the Hoist React framework. It ensures documentation consistency across the framework by validating inter-document links and keeping all indexes updated with on-disk files.

Why do I need a document registry if I already have markdown files?

You need a document registry to maintain a single source of truth for your documentation structure. While markdown files hold content, the registry tracks metadata and relationships, preventing broken links and outdated indexes as files change.