document-release

Cross-reference documentation with code changes and apply updates post-ship.

127k|19.1k|Updated Mar 11, 2026

Search Tags:#code review #documentation #version control #update #automated

Ready to run

npx skills add https://github.com/garrytan/gstack --skill document-release-garrytan

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/garrytan/gstack/tree/main/document-release
Command: npx skills add https://github.com/garrytan/gstack --skill document-release-garrytan

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires gstack, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the update of project documentation after a software release, ensuring that all documentation remains up-to-date with the shipped code.

Core Features & Use Cases

Documentation Audit: Reads all project documentation, cross-references it against the code changes, and identifies updates needed.
Auto-Updates: Applies factual corrections directly to documentation files.
Risk Assessment: Flags risky or questionable changes for user review.
Change Log Polishing: Enhances the readability and effectiveness of the Change Log.
Cross-Doc Consistency: Ensures all documentation is consistent and discoverable.
Todo Cleanup: Updates or removes outdated TODO items.
Version Bump: Optionally bumps the project version number if necessary.
Commit & PR Body Update: Updates the commit message and PR body with documentation changes.
Codex Review: Optionally runs an additional review using Codex to check the documentation against the actual code.

Quick Start

Run the document-release skill after merging a feature branch to update documentation automatically.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I automate documentation updates after a code release?▼

Automating documentation updates post-ship involves reading project docs, cross-referencing them against merged code changes, and applying corrections directly to files while flagging risky updates for manual review.

What is the best way to keep project documentation consistent with shipped code?▼

Keeping documentation consistent requires cross-referencing docs against code changes to apply corrections, polishing the change log, and optionally running an additional automated review to verify accuracy against the actual code.

Do I need a git repository to cross-reference documentation with code changes?▼

Yes, a git repository is required to cross-reference documentation with code changes. The process reads git history to identify code updates and applies corresponding corrections to the documentation files.

Can automated documentation updates flag risky changes for manual review?▼

Yes, automated documentation updates can flag risky changes for manual review. The process identifies questionable modifications during the audit and leaves them for user inspection instead of auto-applying them.

How does an additional automated review check documentation against actual code?▼

An additional automated review checks documentation against actual code by running an optional verification step using Codex. This cross-references the updated documentation files directly with the shipped codebase to ensure accuracy.

Will automating post-ship documentation clean up outdated TODO items?▼

Yes, automating post-ship documentation will clean up outdated TODO items. The process updates or removes outdated TODOs and can optionally bump the project version number and update the commit message and PR body.