update-docs

Update documentation pages by applying surgical edits based on code changes since the last watermark.

1.5k|159|Updated Mar 13, 2026
One-click install
npx skills add https://github.com/fabro-sh/fabro --skill update-docs-fabro-sh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/fabro-sh/fabro/tree/main/.claude/skills/docs
Command: npx skills add https://github.com/fabro-sh/fabro --skill update-docs-fabro-sh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Documentation often falls out of date when code changes are made, causing confusion and wasted time. This Skill automatically detects code changes since the last run using a watermark, and updates documentation pages to stay in sync with the codebase.

Core Features & Use Cases

  • Read the watermark and gather code changes since the last run to identify affected docs.
  • Map changed files to the appropriate docs pages using the code-to-doc mapping.
  • Apply surgical edits to docs/pages and refresh the documentation set while updating the watermark.
  • Use cases include keeping docs/public up to date for main branches, release notes, and contributor guidance.

Quick Start

Run the update-docs workflow to refresh docs/public based on code changes since the watermark.

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 when code changes?

You can automatically update documentation by reading a git watermark to collect code changes since the last run, cross-referencing a code-to-doc mapping, and applying surgical edits to affected pages to keep docs in sync.

What is a watermark in git documentation synchronization?

A watermark in git documentation synchronization is a recorded HEAD hash used to track the last processed state, enabling the collection of subsequent code changes to identify and update only the affected documentation pages.

How do I map code changes to specific documentation pages?

You map code changes to specific documentation pages by using a code-to-doc mapping file that cross-references modified source files with their corresponding docs, allowing targeted surgical edits on only the affected pages.

Does update-docs work without external dependencies?

Yes, update-docs works without external dependencies, relying solely on its internal references component to read git watermarks, gather code changes, apply surgical edits to docs, and write the latest HEAD hash to enforce the patch cycle.

What is the best way to keep docs in lockstep with code changes?

The best way to keep docs in lockstep with code changes is to run an automated workflow that gathers commits since a watermark, cross-references a code-to-doc mapping, applies surgical edits to affected pages, and updates the watermark.

When should I not use automated documentation updates?

You should not use automated documentation updates when your project lacks a defined code-to-doc mapping or a git watermark, as the system requires these to identify affected pages and perform surgical edits accurately.