doc-sync

Sync CLAUDE.md and README.md files across a repository.

42|3|Updated Mar 5, 2021
One-click install
npx skills add https://github.com/fmoda3/nix-configs --skill doc-sync-fmoda3
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/fmoda3/nix-configs/tree/main/home/claude-code/config/skills/doc-sync
Command: npx skills add https://github.com/fmoda3/nix-configs --skill doc-sync-fmoda3

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Documentation drift is common in large repositories as CLAUDE.md and README.md diverge across folders. The doc-sync skill ensures these index and navigation files stay aligned, reducing confusion and manual cleanup.

Core Features & Use Cases

  • Audit and drift detection across the repository to identify missing or outdated CLAUDE.md entries.
  • Content migration moves architectural and design notes from CLAUDE.md into README.md where appropriate.
  • Index maintenance updates the CLAUDE.md table of contents to reflect current files and directories.
  • Scope-targeted syncing can operate repository-wide or within a specific path to support incremental adoption.

Quick Start

Use the doc-sync skill to audit and align CLAUDE.md/README.md across your repository, then run the update pass to rebuild the index.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I detect documentation drift between CLAUDE.md and README.md files?

Detect documentation drift by auditing your repository to identify missing or outdated CLAUDE.md entries. This process scans your repository structure and flags index files that have diverged from actual directory contents, allowing you to target specific paths for incremental alignment.

How do I migrate architectural notes from CLAUDE.md into README.md?

Migrate architectural notes from CLAUDE.md into README.md by running a content migration pass. This process moves appropriate design documentation out of index files into README files, keeping navigation indexes clean and preventing structural content duplication.

What is the best way to rebuild a tabular index for repository documentation?

Rebuild a tabular index for repository documentation by running an index maintenance update. This pass updates the CLAUDE.md table of contents to accurately reflect current files and directories, ensuring documentation navigation remains synchronized with the repository structure.

Can I sync documentation files within a specific subdirectory instead of repo-wide?

Yes, you can sync documentation files within a specific subdirectory instead of repo-wide. Scope-targeted syncing supports incremental adoption by allowing you to audit and align CLAUDE.md and README.md files exclusively within a chosen path.

Do I need external services or dependencies to synchronize repository documentation?

No, you do not need external services or dependencies to synchronize repository documentation. The process relies entirely on standard filesystem operations with local files, requiring no external connections to audit, migrate, and rebuild your CLAUDE.md and README.md indexes.