document-release

Updates project documentation to match shipped code changes after a release.

Updated Aug 9, 2026
One-click install
npx skills add https://github.com/raghavbadhwar/rstack --skill document-release-raghavbadhwar
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/raghavbadhwar/rstack/tree/main/document-release
Command: npx skills add https://github.com/raghavbadhwar/rstack --skill document-release-raghavbadhwar

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After shipping code, project documentation often drifts out of sync with what actually changed. This Skill audits README, ARCHITECTURE, CONTRIBUTING, CHANGELOG, and other docs against the release diff, then updates them so the docs reflect what shipped. ## Core Features & Use Cases - Diataxis coverage mapping: Cross-references the diff against docs to find features missing reference, how-to, tutorial, or explanation coverage, and surfaces documentation debt in the PR body. - Per-file audit and safe updates: Applies factual auto-updates (paths, counts, tables) directly while asking the user before narrative or risky changes, and polishes CHANGELOG voice without ever rewriting entries. - Cross-doc consistency and release hygiene: Checks version alignment, diagram drift, TODOS cleanup, optional VERSION bumps, and commits changes with an updated PR body and title. - Use Case: After merging a feature branch, run this Skill to sync all docs with the shipped diff, polish the CHANGELOG, and append a documentation health summary to the PR. ## Quick Start Ask the agent to update the project documentation to match what shipped on this branch.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update documentation after shipping a release?

Invoke this Skill after a PR is merged or code ships. It reads the branch diff, audits each documentation file against what changed, applies factual updates automatically, and asks before making narrative or risky changes.

What is a Diataxis documentation coverage map?

It is a matrix classifying each shipped feature by reference, how-to, tutorial, and explanation coverage. The Skill builds this map from the diff and flags features with missing quadrants as documentation debt in the PR body.

Does this Skill rewrite my CHANGELOG entries?

No. It only polishes wording within existing entries using exact-match edits and never deletes, reorders, or regenerates entries. If an entry looks wrong, it asks the user instead of silently fixing it.

Will it bump the VERSION file automatically?

No. Version bumps always require explicit user confirmation via a question prompt. If VERSION was already bumped, it verifies the bump covers the full scope of changes before deciding whether to ask again.

What happens if the Codex CLI is not installed for the doc review?

The cross-model documentation review falls back to a Claude subagent when Codex is missing or unauthenticated. The review is informational and non-blocking, and it can be disabled entirely with a config setting.