document-release

Update project documentation files to reflect shipped code changes.

1|Updated May 6, 2026

Search Tags:#automation #changelog #documentation #agents.md #release-notes #docs-sync

Ready to run

npx skills add https://github.com/yckkkk/reo --skill document-release-yckkkk

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates can drift as code ships. This skill reads shipped changes and updates key project docs to keep README.md, ARCHITECTURE.md, CONTRIBUTING.md, AGENTS.md, and CHANGELOG.md in sync with what was released.

Core Features & Use Cases

Reads shipped changes and updates documentation across README.md, ARCHITECTURE.md, CONTRIBUTING.md, AGENTS.md, and CHANGELOG.md.
Polishes CHANGELOG voice and cleans up TODOS to reflect the shipped state.
Optionally bumps the VERSION to align with the new release and can trigger proactive documentation sync after a PR merges or code ships.

Quick Start

After a PR is merged or code is shipped, run this skill to refresh the project docs to reflect the latest release.

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 release?▼

Automate documentation updates after a code release by scanning shipped changes and aligning README.md, ARCHITECTURE.md, and AGENTS.md with the new state. The process uses deterministic scripts to modify specific docs and applies after PR merges.

What is the best way to keep project docs in sync with shipped changes?▼

Keeping project docs in sync with shipped changes is best handled by cross-referencing the release updates and applying deterministic edits. This approach preserves existing wording while updating references to reflect the new release state.

How do I generate and polish CHANGELOG entries from merged PRs?▼

Generate and polish CHANGELOG entries from merged PRs by reading the shipped changes and cleaning up TODOS. The process polishes the CHANGELOG voice and can proactively suggest updates to align with the release.

Can I automatically bump the VERSION file when documentation syncs?▼

Yes, you can automatically bump the VERSION file when documentation syncs. The process optionally bumps the VERSION to align with the new release and maintains idempotence to ensure deterministic edits.

Does this documentation sync approach preserve existing wording in README.md?▼

Yes, this documentation sync approach preserves existing wording in README.md. It uses deterministic edits via scripts to modify specific docs, maintaining idempotence while updating references to shipped changes.

When should I trigger post-ship documentation updates?▼

Trigger post-ship documentation updates after a PR merges or code ships. The process reads the shipped changes and proactively suggests updates to CHANGELOG and version bumps to reflect the new state.