Synchronizes CLAUDE.md navigation indexes and README.md architecture docs across a repository. Use when asked to "sync docs", "update CLAUDE.md files", "ensure documentation is in sync", "audit documentation", or when documentation maintenance is needed after code changes.
Detected risks:
The 'doc-sync' skill is designed to maintain and synchronize documentation across a repository, particularly focusing on CLAUDE.md and README.md files. This skill ensures that the necessary documentation structure and content are always in place, aligned, and updated to reflect the current state of the repository. It helps to maintain consistency in documentation, making sure that developers and team members have up-to-date information about project structures, components, and dependencies. By automating the process of auditing, migrating, and updating documentation, it reduces the risk of documentation drift and enhances overall repository quality.
The 'doc-sync' skill synchronizes and maintains the CLAUDE.md and README.md documentation across a repository, ensuring consistency and accuracy of the documentation structure and content.
The skill determines the scope of sync based on user requests, which can specify a repository-wide sync, a specific directory, or even a single file. It audits and updates documentation accordingly within the specified boundaries.
If the skill detects misplaced content in a CLAUDE.md file, such as architectural or design explanations, it migrates this content to the corresponding README.md file to ensure proper content organization.
Yes, content explaining 'why' (e.g., architectural decisions, rationale) should be moved to README.md, while 'how' (e.g., operational commands, build instructions) remains in CLAUDE.md.
You can specify the directory in your request, and the skill will limit the sync and updates to that directory and its subdirectories, rather than performing a repository-wide sync.
Quick Setup:
.claude/skills/Repository
solatis/claude-config