skills.rest
no-session
no-sessionCOMMUNITY
Explore all skills by this author →
𝕏@pawan_kumar100GitHub

document-release

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

107|7|Updated Mar 29, 2026
Search Tags:#changelog#documentation#pull request#readme#release#git diff#version bump
One-click install
npx skills add https://github.com/no-session/pstack --skill document-release-no-session
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/no-session/pstack/tree/main/document-release
Command: npx skills add https://github.com/no-session/pstack --skill document-release-no-session

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After shipping code, project docs like README, ARCHITECTURE, CONTRIBUTING, and CHANGELOG drift out of sync with what actually shipped. This Skill audits every documentation file against the git diff and brings them back in line before the PR merges. ## Core Features & Use Cases - Diff-driven doc audit: Reads all Markdown files in the repo and cross-references them against the branch diff to find stale descriptions, wrong counts, and outdated paths. - Safe auto-updates with guardrails: Applies factual corrections directly (tables, paths, version numbers) while asking before narrative, security, or large rewrite changes. - CHANGELOG voice polish and VERSION check: Polishes wording of existing CHANGELOG entries without ever rewriting them, and asks before any VERSION bump. - Use Case: After merging a feature branch that adds a new command, run this Skill to update the README skills table, mark completed TODOS items, polish the CHANGELOG entry, and commit the doc updates to the PR. ## Quick Start Run /document-release on your feature branch after shipping code to sync all project documentation with the changes in the diff.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update project documentation after shipping code?▼

Run /document-release from your feature branch after code is committed. It reads every Markdown file, cross-references the git diff against the base branch, applies factual fixes automatically, and asks before any risky narrative changes.

What documentation files does document-release check?▼

It discovers all Markdown files up to two levels deep, including README, ARCHITECTURE, CONTRIBUTING, CHANGELOG, TODOS, and CLAUDE.md. It also checks VERSION and verifies every doc is linked from README or CLAUDE.md.

Does document-release work with GitLab merge requests?▼

Yes. It detects the platform from the git remote URL and uses glab for GitLab or gh for GitHub. It updates the PR or MR body with a Documentation section summarizing each file changed.

Will document-release rewrite my CHANGELOG entries?▼

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

Can document-release bump the VERSION file automatically?▼

No. It always asks before bumping VERSION, even when a bump already exists on the branch. If VERSION was already bumped, it verifies the bump covers the full scope of changes and asks if anything significant is uncovered.

Related Skills

Explore More Software Engineering Skills→
concept2cureconcept2cure

ship

Automate the ship workflow from branch merge to pull request creation.

Community
Advanced
ClyptAIClyptAI

ship

Automate release flow by merging branches, running tests, bumping versions, and creating pull requests.

Official
Advanced
atelier-fashionatelier-fashion
159

reflect

Audit recent code changes for correctness, conventions, architecture, and testing.

Official
Advanced
Sir-chawakornSir-chawakorn
33

changelog-generator

Generate changelogs from Git commits in Markdown format.

Community
Intermediate