sync-docs

Update CLAUDE.md files to reflect code changes affecting public APIs.

10|Updated Sep 24, 2025
One-click install
npx skills add https://github.com/pmcp/nuxt-crouton --skill sync-docs-pmcp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/pmcp/nuxt-crouton/tree/main/.claude/skills/sync-docs
Command: npx skills add https://github.com/pmcp/nuxt-crouton --skill sync-docs-pmcp

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Keeps project documentation accurate and synchronized with code changes, reducing manual effort and errors.

Core Features & Use Cases

  • Automates documentation updates by analyzing code modifications and adjusting relevant CLAUDE.md files.
  • Ensures consistency between codebase and documentation across packages and apps.
  • Use Case: When a new composable is added or renamed, the Skill updates the corresponding CLAUDE.md entry automatically, maintaining accurate package documentation.

Quick Start

Use the skill to analyze recent code changes and automatically update the package documentation files.

Frequently Asked Questions about sync-docs

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

FAQPage Schema
How do I keep documentation up-to-date when refactoring public APIs?

To keep documentation up-to-date when refactoring public APIs, you can parse code differences, match modifications to existing docs, and apply precise minimal edits. This reduces manual effort and ensures consistency between the codebase and package documentation.

What is the best way to automate CLAUDE.md updates after code changes?

Automating CLAUDE.md updates involves analyzing recent code modifications affecting public APIs and adjusting the corresponding documentation entries automatically. This ensures consistency across packages and apps without requiring manual intervention.

How does code sync for documentation identify which files need updates?

Code sync for documentation identifies which files need updates by parsing code differences in your packages and matching those modifications to existing documentation files. It then makes precise, minimal edits to reflect recent changes.

Does this documentation sync approach work with codebases that have minimal docs?

This documentation sync approach is designed for codebases with substantial documentation coverage. It requires matching code changes to existing docs, so it works best when there is already accurate package documentation to synchronize with recent modifications.

When should I use automated documentation updates instead of manual editing?

You should use automated documentation updates when you need to ensure consistency across packages and apps after modifying public APIs. It reduces manual effort and errors by applying precise, minimal edits to relevant files based on parsed code differences.