sync-docs-from-diff

What problem does it solve?

Keeping project documentation (root README, docs directory files, inline markdown docs near changed code) in sync with code changes across branches is tedious and error-prone, often leading to outdated docs that mislead users and waste developer time.

Core Features & Use Cases

• Diff-Based Doc Analysis: Automatically analyzes commits and diffs between a base branch (e.g. develop) and HEAD to identify all code changes that require documentation updates.
• Non-Destructive Patch Generation: Creates proposed updates for three separate doc areas (root README, docs/ directory, inline code docs) without modifying original files, so you can review all changes before applying them.
• Flexible Workflow Support: Supports partial re-runs for specific doc areas (e.g. only README, only docs) and resumable sessions for interrupted work, so you don't have to restart the entire process if you only need to update one section.
• Use Case: After merging a feature branch that adds new API endpoints and updates CLI commands, use this skill to automatically generate updated API docs in the docs folder, revised README entries, and updated inline docs for the changed API files, review each change, and apply only the approved updates.

Quick Start

Use the sync-docs-from-diff skill to analyze code changes between the develop branch and your current branch, generate proposed documentation updates for the README, docs folder, and inline code docs, review each proposed change, and apply only the approved updates.