update-docs
Keeps documentation in sync with code by analyzing recent commit history.
Install
mkdir -p .claude/skills/update-docs-fabro-sh && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/12458" && unzip -o skill.zip -d .claude/skills/update-docs-fabro-sh && rm skill.zipInstalls to .claude/skills/update-docs-fabro-sh
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Update documentation in docs/public/ based on recent code changes. Reads git history since a watermark commit, maps changed files to doc pages, and makes surgical edits to keep docs in sync with code.Key capabilities
- →Read watermark commit SHA
- →Gather changed files and commit messages since watermark
- →Map code changes to documentation pages
- →Filter for user-facing behavioral changes
- →Update affected documentation sections surgically
- →Validate DOT examples in documentation
How it works
The skill reads git history to identify code changes, maps them to documentation pages using a mapping file, and then performs surgical edits to keep the documentation synchronized. It validates DOT examples after updates.
Inputs & outputs
When to use update-docs
- →Sync docs with new features
- →Update documentation after refactoring
- →Map code changes to doc pages
About this skill
Update Docs
Detect code changes since the last run and update affected documentation pages.
- references/mapping.md — code-to-doc page mapping
- Follow
CONTRIBUTING.mdandAGENTS.md(repo root) for writing style
Workflow
1. Read watermark
Read .claude/skills/docs/watermark for the last processed commit SHA. If the file is missing (first run), use the commit from 30 days ago as the starting point: git log --before="30 days ago" --format=%H -1 main.
2. Gather changes
Run git log --oneline --no-merges --name-only <watermark>..HEAD to get changed files and commit messages since the watermark.
3. Map changes to doc pages
Cross-reference changed files against the code-to-doc mapping in references/mapping.md. Also use judgment for unmapped files (e.g., new crates or modules that clearly affect user-facing behavior).
Filter to user-facing behavioral changes only:
- New features, flags, commands, config options, node types
- Changed behavior, renamed APIs, new integrations
- Bug fixes that affect documented behavior
Skip:
- Internal refactors with no behavior change
- Test-only changes
- CI/CD pipeline changes
- Dependency bumps
- Code style or linting changes
If nothing affects docs, tell the user and stop.
4. Read code and docs
For each affected doc page: read the current MDX file and the relevant source files. Identify sections that are outdated, missing, or incorrect.
5. Update doc pages
Surgical edits only — change only affected sections. Preserve existing voice, structure, heading hierarchy, and Mintlify component usage.
- Add code examples for new features (CLI commands, config snippets, DOT syntax)
- Insert rows into reference tables in logical position
- Add new sections for entirely new capabilities
- Update existing descriptions when behavior changes
- Never edit
docs/public/api-reference/fabro-api.yaml— that is the API workflow's source of truth
6. Validate DOT examples
If any updated page contains ```dot code blocks with digraph definitions, run ./test/docs/run_tests.sh validate. Fix any failures before proceeding.
7. Write watermark
Write the output of git rev-parse HEAD to .claude/skills/docs/watermark.
8. Summarize
List updated doc pages and what changed in each.
When not to use it
- →When changes are internal refactors with no behavior change
- →When changes are test-only
- →When changes are CI/CD pipeline related
Limitations
- →Only performs surgical edits; preserves existing voice, structure, and heading hierarchy
- →Never edits `docs/public/api-reference/fabro-api.yaml`
- →Requires a `references/mapping.md` file for code-to-doc page mapping
How it compares
This skill automates the process of updating documentation based on code changes, ensuring docs remain current without manual tracking.
Compared to similar skills
update-docs side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| update-docs (this skill) | 0 | 2mo | No flags | Intermediate |
| prepare-changelog | 6 | 7mo | Review | Beginner |
| workthrough | 10 | 8mo | Review | Beginner |
| generate-release-notes | 7 | 8mo | Review | Intermediate |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
prepare-changelog
nextest-rs
Guidelines for preparing changelog entries for nextest releases following Keep a Changelog format
workthrough
bear2u
Automatically document all development work and code modifications in a structured workthrough format. Use this skill after completing any development task, bug fix, feature implementation, or code refactoring to create comprehensive documentation.
generate-release-notes
teambit
Generate comprehensive release notes for Bit from git commits and pull requests. Use when creating release notes, building changelogs, documenting version releases, or preparing a new Bit release.
changelog-generator
ComposioHQ
Automatically creates user-facing changelogs from git commits by analyzing commit history, categorizing changes, and transforming technical commits into clear, customer-friendly release notes. Turns hours of manual changelog writing into minutes of automated generation.
release-note-generation
microsoft
Toolkit for generating PowerToys release notes from GitHub milestone PRs or commit ranges. Use when asked to create release notes, summarize milestone PRs, generate changelog, prepare release documentation, request Copilot reviews for PRs, update README for a new release, manage PR milestones, or collect PRs between commits/tags. Supports PR collection by milestone or commit range, milestone assignment, grouping by label, summarization with external contributor attribution, and README version bumping.
doc-check
coder
Checks if code changes require documentation updates