skills.rest
lucas-flatwhite
lucas-flatwhiteCOMMUNITY
Explore all skills by this author →
𝕏@lucas_flatwhiteGitHub

document-release

Synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after a ship.

43|7|Updated Mar 13, 2026
Search Tags:#automation#changelog#versioning#documentation#docs#diff-analysis
One-click install
npx skills add https://github.com/lucas-flatwhite/gstack-ko --skill document-release-lucas-flatwhite
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/lucas-flatwhite/gstack-ko/tree/main/document-release
Command: npx skills add https://github.com/lucas-flatwhite/gstack-ko --skill document-release-lucas-flatwhite

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates post-ship documentation updates by reading all project docs, cross-referencing the diff, and updating core docs (README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md) to match shipped changes, while polishing CHANGELOG and cleaning up TODOS, and optionally bumping VERSION. Use after a PR is merged or code is shipped.

Core Features & Use Cases

  • Cross-document synchronization after a release: keeps README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md aligned with the latest code.
  • CHANGELOG polish and TODOS cleanup: makes the release notes precise and actionable.
  • Optional version bump: can bump VERSION when changes warrant it.

Quick Start

Invoke this skill after a ship or PR merge by typing /document-release to update the docs and changelog across the repository.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automatically update README and ARCHITECTURE docs after a release?▼

To synchronize documentation after a release, you cross-reference the code diff and update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match shipped changes, ensuring all repository files reflect the latest version.

What is the best way to clean up a CHANGELOG and TODOS after merging a PR?▼

The best way to polish a CHANGELOG and clean up TODOS after a PR merge is to analyze the shipped code diff and refine release notes to make them precise and actionable across the repository.

Can I automatically bump the VERSION file when shipping documentation updates?▼

Yes, you can bump the VERSION file when shipping documentation updates, as the process supports optional version bumping when code changes warrant it alongside synchronizing core docs and polishing the CHANGELOG.

When should I synchronize project documentation with the latest code?▼

You should synchronize project documentation with the latest code in post-ship scenarios, specifically after a PR is merged or code is shipped, ensuring README, ARCHITECTURE, and CONTRIBUTING files align with the new state.

Does post-ship documentation synchronization require access to the repository?▼

Yes, post-ship documentation synchronization requires access to repository docs to read project files, cross-reference the diff, and apply updates to core documentation like README, ARCHITECTURE, and CLAUDE.md.

Related Skills

Explore More Content & Communication Skills→
shihwesleyshihwesley

document-release

Update Markdown documentation and changelog after a release.

Community
Intermediate
nhattran998nhattran998

document-release

Cross-reference repository diffs and update project documentation after releases.

Community
Advanced
zaeem-rafiqzaeem-rafiq

document-release

Automate post-ship documentation updates across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE files.

Community
Advanced
evanfang0054evanfang0054

documentation-sync

Automates project documentation updates from code changes.

Community
Advanced