doc-sync

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

Updated Feb 5, 2026
One-click install
npx skills add https://github.com/flybirdxx/RunningHub --skill doc-sync-flybirdxx
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/flybirdxx/RunningHub/tree/main/.gemini/skills/doc-sync
Command: npx skills add https://github.com/flybirdxx/RunningHub --skill doc-sync-flybirdxx

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

The doc-sync Skill solves the problem of scattered, out-of-date documentation within a repository, providing a systematic approach to maintaining CLAUDE.md and README.md files.

Core Features & Use Cases

  • Documentation Synchronization: Ensures that all documentation is up-to-date across the repository.
  • Navigation and Indexing: Generates comprehensive indexes for easy navigation and discovery of documentation.
  • Content Migration: Migrates inappropriate content from CLAUDE.md to README.md for better organization.

Quick Start

Run 'doc-sync' to synchronize documentation in your repository.

Frequently Asked Questions about doc-sync

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

FAQPage Schema
How do I automate repository documentation synchronization for README.md and CLAUDE.md files?

You can automate repository documentation synchronization by running the doc-sync process to parse and align file contents. This ensures your CLAUDE.md and README.md files maintain a consistent documentation structure across the repository without manual edits.

What is the best way to organize scattered repository documentation and generate indexes?

Organizing scattered repository documentation involves generating comprehensive indexes for navigation and migrating misplaced content. Moving inappropriate sections from CLAUDE.md to README.md ensures better documentation organization and easier content discovery.

How do I migrate inappropriate content from CLAUDE.md to README.md?

Migrating inappropriate content from CLAUDE.md to README.md is handled automatically during the documentation synchronization process. The tool identifies misplaced text and reorganizes it into the correct documentation files to maintain structural consistency.

Do I need specific file parsing tools to maintain a consistent documentation structure?

Yes, appropriate file parsing tools are required to access repository files and maintain a consistent documentation structure. The synchronization process relies on these tools to read, index, and reorganize the content within your markdown files accurately.

Can I use documentation synchronization for large repositories with scattered files?

Documentation synchronization is designed to handle repositories with scattered files by providing detailed indexing and organization. It systematically scans the repository to locate relevant information and enforces a consistent documentation structure across the codebase.