document-release

Audit markdown documentation against code diffs and update release notes.

8|2|Updated Mar 24, 2026

Search Tags:#changelog #documentation #contributor onboarding #post-ship #diff audit #version coordination #quality cleanup

Ready to run

npx skills add https://github.com/MFS-code/gstack --skill document-release-mfs-code

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents documentation from getting out of date after code ships, so users and contributors trust what they read.

Core Features & Use Cases

Post-ship documentation updates: Reads the project’s docs and the code diff to bring README and key contributor docs up to date.
Cross-reference accuracy: Checks that documentation matches what changed, including commands, behavior, and paths.
Polished release narrative: Cleans up TODOs and improves CHANGELOG voice without clobbering existing entries.

Quick Start

Ask your AI agent to run /document-release to update the repo documentation based on what you shipped and fix any stale references.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I keep repository documentation synchronized with recently shipped code changes?▼

To synchronize repository documentation, run a post-merge diff audit against your current release context. This updates README files and contributor guides to accurately reflect shipped code changes without clobbering your existing CHANGELOG entries.

What is the best way to update stale markdown docs after a release?▼

Updating stale markdown docs after a release requires a diff-driven audit of your project instructions and architecture files. This process checks cross-reference accuracy, ensuring documented commands and paths match your newly shipped code behavior.

How do I polish a CHANGELOG without overwriting existing release entries?▼

Polishing a CHANGELOG without overwriting entries involves applying targeted narrative updates that clean up TODOs and improve wording voice. The process follows safety rules to prevent risky changes while leaving your existing release history intact.

Can I automatically bump a project's VERSION number during a documentation refresh?▼

No, you cannot automatically bump a project's VERSION number during a documentation refresh. The process follows strict safety rules for VERSION bump decisions, requiring manual intervention to coordinate version changes and prevent unintended release conflicts.

When should I run a post-ship documentation audit for my contributor onboarding guides?▼

You should run a post-ship documentation audit immediately after merging code changes to keep contributor onboarding guides accurate. This ensures new contributors trust the documented commands, behaviors, and architecture paths they read.