update-docs

Synchronize project documentation with code changes via git diffs.

41|7|Updated Jan 30, 2026

Search Tags:#automation #git #documentation #docs #update #frontmatter #code-change

Ready to run

npx skills add https://github.com/DGouron/review-flow --skill update-docs-dgouron

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/DGouron/review-flow/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/DGouron/review-flow --skill update-docs-dgouron

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts from the codebase as changes are made, leading to outdated or incorrect guidance and increased support costs.

Core Features & Use Cases

Automated doc-sync: Detects changes via git diffs and updates related documentation sections, frontmatter, and cross-links.
Frontmatter maintenance: Updates last-updated timestamps and related metadata to reflect the current state.
Audit & reporting: Generates a changelog of modifications and surfaces gaps for reviewers.

Quick Start

Run the /update-docs command to synchronize docs with the latest code changes.

Frequently Asked Questions about update-docs

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

FAQPage Schema

How do I automatically update documentation to match code changes in git?▼

You can automatically keep docs in sync by computing git diffs to detect code changes and then updating related documentation sections, frontmatter, and cross-links. This approach preserves existing content while updating YAML metadata like last-updated timestamps.

What is the best way to keep YAML frontmatter updated with frequent git commits?▼

Automating documentation synchronization is the best way to keep YAML frontmatter current with frequent commits. It computes git diffs and automatically updates last-updated timestamps and related metadata to reflect the current codebase state.

Does automated documentation sync work with existing README files?▼

Yes, automated documentation sync works with existing README files and docs/ directories. It detects changes via git diffs, updates related documentation sections, and preserves your existing content while modifying frontmatter and cross-links.

How do I generate a changelog of documentation updates for code reviewers?▼

You can generate a changelog of documentation updates for reviewers by using an automated doc-sync tool. After computing git diffs and updating frontmatter, this Skill reports a changelog of modifications and surfaces documentation gaps.

Do I need git access to automate documentation synchronization?▼

Yes, you need git access to automate documentation synchronization. The process requires git access to compute diffs between commits, which is necessary to detect code changes and update related docs, frontmatter, and cross-links accordingly.

Why does my project documentation drift out of sync with the codebase?▼

Project documentation drifts out of sync with the codebase because manual updates are often missed during frequent commits. Automating doc synchronization detects changes via git diffs and updates related sections, preventing outdated guidance and increased support costs.