skills.rest
solatis
solatisCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-sync

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

898|134|Updated Jul 28, 2025
Search Tags:#documentation#synchronization#README#CLAUDE.md#docs maintenance
One-click install
npx skills add https://github.com/solatis/claude-config --skill doc-sync-solatis
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/solatis/claude-config/tree/main/skills/doc-sync
Command: npx skills add https://github.com/solatis/claude-config --skill doc-sync-solatis

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift between CLAUDE.md navigation indexes and architecture README.md can cause confusion. This Skill ensures navigation and architecture docs stay in sync across the repository.

Core Features & Use Cases

  • CLAUDE.md audit & alignment: Verify and update index tables to reflect current structure.
  • README.md maintenance: Generate or update architecture docs when needed.
  • Repository consistency: Maintain up-to-date documentation across dirs after changes.

Quick Start

Run the doc-sync skill to audit and update CLAUDE.md and README.md across the repository. Example: python3 scripts/doc_sync.py --scope repository

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I keep documentation and README files in sync across my repository?▼

Documentation synchronization ensures your CLAUDE.md navigation indexes and README.md architecture docs stay aligned. Use doc-sync to audit index tables, verify current structure, and update both files together after code changes, preventing drift across the repository.

What is CLAUDE.md and why maintain it alongside README?▼

CLAUDE.md is a navigation index with tabular What and When columns that documents repository structure and file purposes. Maintaining it alongside README.md provides dual layers: quick navigation reference plus detailed architecture documentation, reducing confusion when either drifts.

Can I sync documentation for specific directories instead of the whole repository?▼

Yes, doc-sync supports directory-specific synchronization. You can target individual directories like src/validator/ or single files, enabling granular documentation updates after localized code changes without auditing the entire repository.

How do I detect when documentation has drifted from the actual codebase?▼

Doc-sync performs drift and missing-content audits by comparing current code structure against documented indexes. Run repository-wide or scoped audits to identify gaps, misaligned entries, and outdated architecture docs that need correction.

What happens to my documentation when I update the codebase structure?▼

After code changes, doc-sync coordinates content migration between CLAUDE.md and README.md according to your workflow. It updates index tables to reflect new structure, removes stale references, and ensures both files represent the current repository layout.

Related Skills

Explore More Content & Communication Skills→
RichJacobs69RichJacobs69

repo-reviewer

Audit code repositories for duplication, stale files, and structural inefficiencies.

Community
Advanced
WhiskeyJack96WhiskeyJack96
15

release-new-version

Automate Obsidian plugin releases from version bump to release notes.

Community
Advanced
Snowflake-LabsSnowflake-Labs
12

read-ors-configuration

A concise summary of your roleplay character: name,</name> personality, and/or behavior, formatted as a single string sentence. Typically不超过50字，此处省略

Official
Intermediate
windyskywindysky

moai-platform-railway

Deploy and manage Railway container deployments with Docker, volumes, and auto-scaling.

Community
Advanced