document-release

Cross-reference code changes and update project documentation files.

1|Updated Mar 24, 2026
One-click install
npx skills add https://github.com/greencm/gstuck --skill document-release-greencm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/greencm/gstuck/tree/main/output/gstack/document-release
Command: npx skills add https://github.com/greencm/gstuck --skill document-release-greencm

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires bash, read, write, edit, grep, glob, askuserquestion, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This skill addresses the challenge of updating project documentation after new code or features have been shipped, ensuring that documentation remains current and aligned with the latest codebase.

Core Features & Use Cases

  • Automated Documentation Update: Reads and cross-references project documentation with the code changes to ensure accuracy and consistency.
  • Change Detection: Identifies updates required in various documentation files such as README, Architecture, Contributing, and CHANGELOG based on code changes.
  • Version Bump Management: Optionally suggests and applies version bumps to the project's VERSION file when necessary.
  • PR/MR Body Updates: Automatically updates the PR or MR body with documentation changes and identifies gaps in documentation coverage.
  • Codex Documentation Review: Optionally performs an additional review of the documentation using Codex to ensure accuracy and completeness.

Quick Start

Use the document-release skill to update the project documentation after a code merge. Run the skill by entering: document-release update

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 merge?

Automating documentation updates after a code merge involves cross-referencing project docs with code changes to identify and apply updates. This process reads files like README and CHANGELOG to keep documentation in sync with the codebase.

What is the best way to keep documentation in sync with the codebase?

Keeping documentation in sync with the codebase requires cross-referencing code changes against existing documentation files to detect gaps. Automated tools can read, edit, and update README, Architecture, and Contributing files to maintain alignment after shipment.

Does this documentation update process work with PR and MR body updates?

Yes, this documentation update process works with PR and MR body updates by automatically updating the pull request or merge request body with documentation changes. It also identifies gaps in documentation coverage based on the detected code changes.

Can I automatically update the CHANGELOG and version bump after shipping?

Yes, you can automatically update the CHANGELOG and apply version bumps after shipping. The process detects required updates in documentation files and optionally suggests or applies version bumps to the project's VERSION file when necessary.

Do I need Bash and Grep to run automated documentation updates?

Yes, you need Bash, Grep, Glob, Read, Write, and Edit tools to run automated documentation updates. These tools are required to process project files, search through the codebase, and apply the identified documentation changes accurately.

What are the limitations of automated code sync for documentation?

Limitations of automated code sync for documentation include potential gaps in coverage detection that require manual review. The process optionally performs an additional review using Codex to ensure accuracy and completeness, but complex changes may still need human verification.