skills.rest
LaPaGaYo
LaPaGaYoCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Sync README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes.

1|Updated Mar 31, 2026
Search Tags:#documentation#release#CLAUDE.md#CHANGELOG#docs-sync#version-bump#readme-update
One-click install
npx skills add https://github.com/LaPaGaYo/nexus --skill document-release-lapagayo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/LaPaGaYo/nexus/tree/main/skills/support/document-release
Command: npx skills add https://github.com/LaPaGaYo/nexus --skill document-release-lapagayo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates require aligning multiple docs with what shipped. This Skill reads project docs, cross-references diffs, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match shipped changes. It also polishes the CHANGELOG voice, cleans up TODOS, and can optionally bump the version.

Core Features & Use Cases

  • Syncs README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes
  • Polishes CHANGELOG language and tone for release readability
  • Cleans up TODOS to reflect current project state
  • Optionally bump VERSION to align with new release
  • Use case: after a PR merge or release to ensure docs reflect code and governance artifacts

Quick Start

Run after a ship or PR merge to sync docs and polish release notes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I sync README and CLAUDE.md with shipped code changes after a release?▼

To automate documentation updates, run a post-ship docs sync process that cross-references code diffs and aligns README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with the merged changes.

What is the best way to polish a CHANGELOG after merging a pull request?▼

Polishing a CHANGELOG after a PR merge involves reviewing the shipped changes, refining the release notes language and tone for readability, and cleaning up TODOS to reflect the current project state.

Can I automatically bump the VERSION file when updating project documentation?▼

Yes, you can optionally bump the VERSION file during the documentation sync process to align the version number with the new release and the updated core project docs.

When do I need to update ARCHITECTURE and CONTRIBUTING docs?▼

You need to update ARCHITECTURE and CONTRIBUTING docs after a ship or PR merge when structural changes occur, ensuring governance artifacts and architecture descriptions reflect the actual shipped code.

Does post-ship docs sync work without external dependencies?▼

Yes, the post-ship documentation sync runs without external dependencies, reading project docs and cross-referencing diffs internally to align README, CLAUDE.md, and other files with the shipped state.

Related Skills

Explore More Content & Communication Skills→
scanbottscanbott

document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after shipping code releases.

Community
Advanced
jewbetchajewbetcha
115

changelog-generator

Generate user-facing release notes from Git commit history.

Community
Basic
zaeem-rafiqzaeem-rafiq

document-release

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

Community
Advanced
esopianesopian
2

document-release

Update project documentation files to reflect shipped code and version changes.

Community
Intermediate