skills.rest
AlexandreLab
AlexandreLabCOMMUNITY
Explore all skills by this author →
GitHub

gstack-document-release

Update repository documentation files after merged code changes.

Updated Apr 12, 2026
Search Tags:#changelog#documentation#readme#release#diff#docs
One-click install
npx skills add https://github.com/AlexandreLab/dotfiles --skill gstack-document-release-alexandrelab
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: gstack-document-release
Source: https://github.com/AlexandreLab/dotfiles/tree/main/claude/skills/gstack-document-release
Command: npx skills add https://github.com/AlexandreLab/dotfiles --skill gstack-document-release-alexandrelab

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation update across a repository to ensure docs reflect shipped changes and stay in sync with code.

Core Features & Use Cases

  • Reads diffs from merged changes and updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect what shipped.
  • Polishes and standardizes CHANGELOG language, cleans up TODOS, and optionally bumps the VERSION when appropriate.
  • Enables an automated post-ship documentation workflow to keep project docs up to date.

Quick Start

Use the document-release workflow after shipping to automatically sync documentation across key docs.

Frequently Asked Questions about gstack-document-release

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

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

To update documentation after shipping code changes, you can automate the process by reading merged PR diffs and aligning README.md, ARCHITECTURE.md, and CONTRIBUTING.md directly with the shipped code changes.

What is the best way to keep a CHANGELOG and TODOS in sync with merged PRs?▼

Keeping a CHANGELOG and TODOS in sync with merged PRs is best handled by an automated post-ship workflow that polishes CHANGELOG language, cleans up TODOS, and optionally bumps the VERSION based on the shipped diff.

Can I automatically update CLAUDE.md to reflect shipped changes in my repository?▼

Yes, you can update CLAUDE.md to reflect shipped changes by running an automated post-ship documentation workflow that reads the diff from merged code and updates referenced project docs.

Does this post-ship documentation workflow require any external dependencies?▼

No, this post-ship documentation workflow requires no external dependencies, allowing you to directly automate documentation updates across your repository without additional environment setup.

When should I use an automated documentation update workflow for my repository?▼

You should use an automated documentation update workflow immediately after a PR is merged or code is shipped, ensuring your README, CHANGELOG, and project docs consistently reflect the latest changes without manual effort.

Related Skills

Explore More Content & Communication Skills→
legotec73legotec73

document-release

Update project docs from diffs after code shipment.

Community
Intermediate
luicabref97luicabref97

docs:update-docs

Analyze code diffs to generate prioritized documentation update tasks.

Community
Advanced
jm199seojm199seo

document-release

Scan project diffs and update documentation files to reflect shipped changes.

Community
Advanced
zhu637882-stackzhu637882-stack

document-release

Update project docs and changelog to reflect a shipped diff.

Community
Advanced