sync-docs-from-diff

Generate non-destructive documentation update proposals from Git diffs.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/hicucu/forge --skill sync-docs-from-diff
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sync-docs-from-diff
Source: https://github.com/hicucu/forge/tree/main/skills/sync-docs-from-diff
Command: npx skills add https://github.com/hicucu/forge --skill sync-docs-from-diff

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about sync-docs-from-diff

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

FAQPage Schema
How do I automatically update README and inline docs based on git branch changes?

This skill synchronizes project documentation with code changes by analyzing git diffs between a base branch and HEAD, generating non-destructive patch proposals for your root README, docs directory, and inline markdown files for review.

What is the best way to sync project documentation after merging a feature branch?

The best way to sync project documentation after merging a feature branch is to analyze the code diffs and generate proposed updates for the README, docs folder, and inline code docs, reviewing each change before applying only the approved modifications to eliminate outdated docs.

Can I update only the root README without modifying the docs directory files?

Yes, you can update only the root README because the workflow supports partial re-runs for specific documentation areas, allowing you to target individual sections without restarting the entire synchronization process.

Do I need a specific Git repository setup to generate documentation patch proposals?

Yes, you need a valid Git repository with a detectable base branch to generate documentation patch proposals, as the diff-based analysis relies on comparing your current HEAD against a base branch to identify code changes requiring doc updates.

Does generating documentation updates modify my original code files?

Generating documentation updates does not modify your original files because the tool creates non-destructive patch proposals for three distinct doc areas, enabling you to safely review all proposed changes and perform post-application validation before applying any updates.

Why is my documentation synchronization process not resuming after an interruption?

Your documentation synchronization process might not resume because it requires using the supported resumable sessions feature, which allows interrupted work to continue without restarting, ensuring partial re-runs for specific doc areas like the README or docs directory are properly tracked.