sync-docs

Detect code changes from git diffs and update corresponding documentation sections.

Updated Dec 31, 2025
One-click install
npx skills add https://github.com/clover-storm/agentic --skill sync-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-docs
Source: https://github.com/clover-storm/agentic/tree/main/.claude/skills/sync-docs
Command: npx skills add https://github.com/clover-storm/agentic --skill sync-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automatically detects and reconciles code changes with related documentation, preventing drift between source and docs.

Core Features & Use Cases

  • Change detection: Monitors commits and diffs to identify impacted documentation.
  • Automatic synchronization: Updates or creates documentation artifacts to reflect code changes.
  • Use Case: After adding a new API endpoint, the corresponding API spec and docs are refreshed automatically.

Quick Start

Run the sync-docs skill after committing code or via a trigger to update docs in sync with the latest changes.

Frequently Asked Questions about sync-docs

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

FAQPage Schema
How do I automatically keep documentation in sync with code changes?

Automatically sync documentation with code changes by running the sync-docs Skill after commits. It detects git diffs, maps changes to documentation sections like routes and controllers, and updates corresponding docs to reflect the latest code—preventing drift between source and documentation.

Can I update API docs automatically when I add new endpoints?

Yes. When you add a new API endpoint and commit the change, sync-docs parses the git diff, identifies the endpoint addition, and automatically refreshes your API spec and related documentation artifacts.

What does git diff parsing accomplish for documentation?

Git diff parsing identifies exactly which code sections changed—routes, controllers, services, tests—and maps those changes to corresponding documentation sections. This precision enables automatic updates without manual specification of what docs to refresh.

When should I run the sync-docs Skill in my workflow?

Run sync-docs after committing code or via a trigger to reconcile documentation with the latest changes. It's designed for projects where docs live alongside source code and must reflect every commit.

Does this work if documentation and code live in the same repository?

Yes. sync-docs is built for projects where documentation lives alongside source code in the same repository, automatically detecting and synchronizing changes across both.