skills.rest
mikeacjones
mikeacjonesCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-sync

Synchronize CLAUDE.md navigation indexes and README architecture docs across a repository.

Updated Dec 9, 2025
Search Tags:#documentation#markdown#audit#README#CLAUDE.md#documentation-sync
One-click install
npx skills add https://github.com/mikeacjones/IronPath --skill doc-sync-mikeacjones
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/mikeacjones/IronPath/tree/main/.claude/skills/doc-sync
Command: npx skills add https://github.com/mikeacjones/IronPath --skill doc-sync-mikeacjones

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Synchronizes CLAUDE.md navigation indexes and README architecture docs across a repository to maintain consistent documentation after code changes.

Core Features & Use Cases

  • Documentation alignment: maintains a coherent CLAUDE.md index across directories.
  • Drift detection & migration: identifies drift and moves misplaced content to README.md when needed.
  • Index regeneration: updates file and subdirectory entries to reflect the current project structure.

Quick Start

Invoke the doc-sync skill with REPOSITORY-WIDE scope to audit and align all CLAUDE.md indices in the project.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I keep CLAUDE.md navigation indexes consistent after code changes?▼

To keep CLAUDE.md navigation indexes consistent after code changes, synchronize your repository documentation to detect drift, migrate misplaced content to README.md, and regenerate file and subdirectory entries to reflect the current project structure.

What is the best way to audit and align CLAUDE.md files across a repository?▼

Auditing and aligning CLAUDE.md files across a repository involves running a repository-wide synchronization to enforce a pure index format for subdirectories and update README architecture docs to ensure documentation remains consistent.

How do I fix documentation drift in my project's markdown files?▼

Fixing documentation drift in markdown files requires detecting structural inconsistencies, migrating misplaced content from CLAUDE.md indices to README.md, and regenerating file and subdirectory entries to match the current codebase.

Can I run documentation sync on a scoped boundary instead of the whole repository?▼

Yes, documentation synchronization can be applied to either repository-wide audits or scoped boundaries, allowing you to align CLAUDE.md indices and README architecture docs for specific subdirectory sections.

When should I move content from a CLAUDE.md file to a README.md?▼

Content should be migrated from a CLAUDE.md file to a README.md when it does not fit the pure index format, ensuring subdirectory CLAUDE.md files remain pure navigation indexes while architecture docs live in README.md.

Why does my CLAUDE.md index format need to be a pure index?▼

A CLAUDE.md index needs to be a pure index to maintain clear navigation, so any misplaced architecture content is detected as drift and migrated to README.md to keep documentation structure consistent.

Related Skills

Explore More Content & Communication Skills→
tamago0224tamago0224

update-markdown-file-index

Update markdown file sections with indexes of folder contents.

Community
Intermediate
t6adevt6adev
3

doc-sync

Detect documentation drift from git history and propose edits to project docs.

Community
Intermediate
padjeipadjei

design-systems-slds-validate

Validate Lightning Web Components for SLDS compliance and generate a detailed scorecard.

Community
Advanced
samjhechtsamjhecht
4

organize-root-files

Route root Markdown files to memos, docs, or devops/docs directories.

Community
Intermediate