doc-sync

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

Updated Jan 19, 2026
One-click install
npx skills add https://github.com/loriensleafs/brain --skill doc-sync-loriensleafs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-sync
Source: https://github.com/loriensleafs/brain/tree/main/apps/claude-plugin/skills/doc-sync
Command: npx skills add https://github.com/loriensleafs/brain --skill doc-sync-loriensleafs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the maintenance of documentation across a repository by synchronizing CLAUDE.md navigation indexes with corresponding README architecture docs, ensuring consistency and reducing manual effort.

Core Features & Use Cases

  • Synchronizes CLAUDE.md index tables with the latest file structure and updates README.md architecture sections accordingly.
  • Performs repository-wide audits and scoped updates (e.g., specific directories or files).
  • Enforces consistent index formats and triggers for file changes or documentation maintenance.

Quick Start

Use the doc-sync skill to audit the repository and apply updates to CLAUDE.md and README.md as needed.

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 synchronized with my repository file structure?

To synchronize CLAUDE.md navigation indexes, you can audit the repository structure, detect documentation drift, and rebuild pure index tables for subdirectories to match the latest files. This ensures your navigation indexes accurately reflect the current repository layout.

What is the best way to update README architecture docs when repository files change?

The best way to update README architecture docs is to trigger a documentation synchronization process that reads existing CLAUDE.md files and applies architecture updates to README.md. This preserves original content while ensuring architecture information stays current with file modifications.

Can I audit documentation drift in a specific directory rather than the whole repository?

Yes, you can audit documentation drift within scoped boundaries like a specific directory or a single file instead of running a repository-wide audit. This targeted approach detects structural drift and applies updates only to the scoped section you specify.

Does doc-sync preserve my existing CLAUDE.md content when rebuilding index tables?

Yes, doc-sync preserves original content while rebuilding pure index tables and updating README.md architecture sections. It reads your existing CLAUDE.md, audits the structure, and applies updates without overwriting your custom documentation or annotations.

How do I perform a repository-wide documentation audit for README and CLAUDE.md files?

To perform a repository-wide documentation audit, trigger a synchronization process that scans your entire repository structure, detects drift between CLAUDE.md navigation and actual files, and applies updates to both CLAUDE.md indexes and README.md architecture docs.