document-release

Read project diffs and update core documentation files to reflect shipped changes.

Updated Apr 3, 2026

Search Tags:#automation #documentation #diff #polish #docs-sync #change-log #release-drift

Ready to run

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

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift after shipping is common. This skill ensures project docs stay accurate across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md by aligning content with what actually shipped.

Core Features & Use Cases

Cross-document alignment: updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect merged changes.
CHANGELOG polish & TODOS cleanup: polishes changelog voice and tidies TODOS for the release.
Optional version bump & proactivity: can suggest or perform a version bump and prompt for proactive actions after code ships.

Quick Start

Run the document-release skill after merging a PR to sync docs across key files and polish the changelog.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I keep documentation in sync with code changes after a release?▼

Documentation drift after shipping is resolved by reading project diffs and updating core docs like README, ARCHITECTURE, and CONTRIBUTING to reflect what actually shipped. This automated alignment ensures your docs stay accurate across key files.

What is the best way to automate changelog polishing and todo cleanup after merging a PR?▼

Automating changelog polishing and TODOS cleanup happens by reading merged diffs and refining the changelog voice while tidying up tasks for the release. This ensures your release notes stay clean and consistent with shipped changes.

Can I automatically update CLAUDE.md and ARCHITECTURE.md based on what shipped in a PR?▼

Yes, cross-document alignment automatically updates CLAUDE.md and ARCHITECTURE.md by reading project diffs from PRs or releases. It ensures these files reflect the merged changes to prevent documentation drift.

Do I need a SKILL.md frontmatter to sync docs across my project files?▼

Yes, a SKILL.md frontmatter with name, preamble-tier, version, and description is required. It may also coordinate optional resources under scripts/, references/, and assets/ directories as directed during the documentation alignment process.

Can I bump my project version automatically when documentation is synced?▼

Yes, optional version bumping can suggest or perform a version update after code ships. It also prompts for proactive actions, ensuring your VERSION file stays current alongside the synced documentation.

Why does documentation drift happen and when should I run a docs-sync process?▼

Documentation drift happens when merged changes are not reflected in project docs. You should run a docs-sync process after every PR merge or release to align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with what shipped.