skills.rest
greglas75
greglas75COMMUNITY
Explore all skills by this author →
GitHub

release-docs

Synchronizes documentation with release changes by analyzing git diffs and updating only affected docs.

6|Updated Mar 27, 2026
Search Tags:#automation#changelog#documentation#release#git diff#doc sync
One-click install
npx skills add https://github.com/greglas75/zuvo --skill release-docs-greglas75
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: release-docs
Source: https://github.com/greglas75/zuvo/tree/main/skills/release-docs
Command: npx skills add https://github.com/greglas75/zuvo --skill release-docs-greglas75

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After a release, documentation often drifts out of sync with the code. This Skill determines exactly which source files changed in a release range and updates only the documentation affected by those changes, avoiding unnecessary rewrites and missed updates. ## Core Features & Use Cases - Diff-driven doc sync: Runs git diff over a release range (auto-detected from tags or a ship artifact) and maps changed source files to documentation via docs-map.yaml, frontmatter sources, or name heuristics. - Changelog verification: Confirms CHANGELOG.md contains an entry for the release without modifying it, since changelog ownership belongs to the ship workflow. - Documentation debt detection: Identifies changed source files with no mapped documentation and reports them as informational debt. - Use Case: After tagging v1.2.0, run the skill to update only the docs whose source modules changed since v1.1.0, with an evidence trail linking every doc claim to a source file and line. ## Quick Start Run the release-docs skill to sync documentation for the latest release range, optionally passing an explicit git range or --dry-run to preview changes.

Frequently Asked Questions about release-docs

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

FAQPage Schema
How do I update documentation after a release automatically?▼

Run the release-docs skill after tagging a release. It computes the changed-file range from git tags or a ship artifact, maps changed source files to docs, and delegates targeted updates so only affected documentation is rewritten.

How does the skill know which docs correspond to which source files?▼

It uses a priority order: an explicit docs/docs-map.yaml mapping first, then sources: globs in doc frontmatter, and finally a name-based heuristic fallback. Explicit mappings take precedence over heuristic matches.

Can I preview documentation changes without writing files?▼

Yes, pass the --dry-run flag. The skill prints which source files would trigger doc updates and which doc files would be modified, then exits without writing anything.

Does release-docs generate or edit the changelog?▼

No. CHANGELOG.md is owned exclusively by the zuvo:ship skill. release-docs only verifies that a changelog entry exists for the release and logs a warning if it is missing.

What happens if no release range can be determined?▼

In interactive environments the skill asks for an explicit range. In non-interactive environments it prints an auto-decision notice, skips documentation sync, and exits with a PASS verdict.

Related Skills

Explore More Software Engineering Skills→
EvolutionAPIEvolutionAPI
520

dev-release

Generate changelogs, bump semver versions, commit, and tag git releases.

Official
Intermediate
jayzalowitzjayzalowitz
2

document-release

Update core docs and CHANGELOG after shipping code changes.

Community
Advanced
mcsdodomcsdodo

verify

Run tests, check git status, and confirm changelog updates for completion readiness.

Community
Intermediate
cliftonccliftonc
9

synthesizing-findings

Generate a REBUILD-PLAN.md from layer findings with reuse and phasing decisions.

Community
Advanced