doc-sync

Synchronizes CLAUDE.md and README.md navigation indexes across a repository.

Updated Apr 18, 2026
One-click install
npx skills add https://github.com/sachio222/based-stack --skill doc-sync-sachio222
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/sachio222/based-stack/tree/main/doc-sync
Command: npx skills add https://github.com/sachio222/based-stack --skill doc-sync-sachio222

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill audits and synchronizes CLAUDE.md/README.md documentation hierarchies across a repository, ensuring consistent, up-to-date navigation for developers and writers.

Core Features & Use Cases

  • Discovery maps all directories, detects missing or outdated CLAUDE.md files.
  • Audit checks for drift, misplaced content, and README.md presence to validate structure.
  • Migration moves architecture and design details from CLAUDE.md to README.md for proper documentation placement.
  • Update creates/refreshes table-based indexes to reflect current files and structure.
  • Verification confirms complete coverage, correct format, and absence of drift across the repo.

Quick Start

Run the doc-sync skill at the repository root to synchronize CLAUDE.md and README.md indexes.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I synchronize CLAUDE.md and README.md navigation indexes across a repository?

To synchronize CLAUDE.md and README.md navigation indexes, run the doc-sync skill at the repository root. It executes a five-phase workflow to detect drift, migrate misplaced content, and update table-based indexes for consistent documentation structure.

What causes documentation drift in CLAUDE.md files and how do I fix it?

Documentation drift occurs when CLAUDE.md files become outdated or missing relative to repository changes. An audit phase detects this drift and misplaced content, followed by migration and update phases that refresh indexes to restore complete navigational coverage.

Can I scope documentation synchronization to specific directories instead of the entire repository?

Yes, documentation synchronization can operate across the entire repository or within scoped directories. The discovery phase maps all targeted directories to detect missing CLAUDE.md files and validate structure before performing any migrations or updates.

What is the best way to migrate architecture details from CLAUDE.md to README.md?

The best way to migrate architecture and design details from CLAUDE.md to README.md is using the migration phase. It identifies misplaced content and moves it to README.md for proper documentation placement, then updates indexes to reflect the corrected structure.

How do I verify that all CLAUDE.md files have complete coverage and correct formatting?

To verify complete coverage and correct formatting, the verification phase checks for the absence of drift and confirms table-based indexes are properly formatted. It ensures all directories contain self-contained documentation with no missing entries.