xh-update-doc-links

Official

Sync documentation across the project.

Authorxh
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: xh-update-doc-links
Download link: https://github.com/xh/hoist-react/archive/main.zip#xh-update-doc-links

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.