docs-sync

Aligns documentation indices and cross-reference links after edits to docs/ files.

3|3|Updated Aug 19, 2024
One-click install
npx skills add https://github.com/AMDResearch/dh_comms --skill docs-sync-amdresearch
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-sync
Source: https://github.com/AMDResearch/dh_comms/tree/main/.agents/skills/docs-sync
Command: npx skills add https://github.com/AMDResearch/dh_comms --skill docs-sync-amdresearch

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Synchronize documentation indices, cross-reference links, and table-of-contents files after docs are added, renamed, moved, or deleted, preventing stale links and orphaned pages.

Core Features & Use Cases

  • Finds orphaned docs and stale links by scanning docs/ recursively.
  • Corrects cross-reference targets within docs and updates indices and TOCs.
  • Generates a sync report detailing changes and items needing manual review.

Quick Start

Update your docs/ tree and run the docs-sync operation to align indices and references.

Frequently Asked Questions about docs-sync

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

FAQPage Schema
How do I fix broken cross-reference links and stale documentation indices after moving files?

Orphaned documentation pages are files left unlinked after edits are made to the docs tree. A sync operation scans the docs directory recursively to find these orphaned pages and updates indices to resolve them.

What is the best way to find orphaned docs that are no longer linked in my table of contents?

Orphaned docs are unlinked files left behind after documentation edits. A synchronization tool scans the docs directory recursively to find orphaned pages, corrects stale links, and updates the index automatically.

Do I need any specific project configuration to enable documentation synchronization?

Documentation synchronization requires the design facet enabled in the .agents/project.json configuration file. This setup allows the tool to scan the docs directory and generate a sync report listing all changes.

How do I generate a report of stale links and manual review items in my docs tree?

Run the documentation synchronization operation after updating your docs tree to generate a sync report. This report details all corrected cross-references, updated indices, and items needing manual review.

When should I avoid using an automated cross-reference sync tool for my documentation?

You should avoid relying solely on automated sync when the generated report flags items needing manual review. Complex cross-reference corrections or non-standard documentation structures often require human intervention to finalize changes.