document-release

Update project documentation files after merged code changes.

1|Updated May 25, 2026

Search Tags:#version control #code synchronization #document update #readme update #change logging

Ready to run

npx skills add https://github.com/chiruu12/nudge --skill document-release-chiruu12

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates post-ship documentation updates by syncing the README, ARCHITECTURE, CONTRIBUTING, and AGENTS.md files with the shipped code changes.

Core Features & Use Cases

Sync Documentation: Updates the documentation files to reflect the changes made to the codebase.
Polish CHANGELOG: Enhances the CHANGELOG section with a polished voice, ensuring clear communication of updates.
Clean Up TODOS: Removes TODO entries from the documentation to maintain a clean and professional look.
Version Bumping: Optionally bumps the version number after successful documentation updates.
Use Case: Ideal for software projects where consistent documentation is crucial for user and developer understanding.

Quick Start

Run the document-release skill after merging a PR to automatically update the documentation.

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 merging code changes?▼

You can automate documentation updates by running a process that reads project docs, cross-references the code diff, and updates files like README and CONTRIBUTING. This syncs documentation with the shipped code changes automatically.

What is the best way to keep my README in sync with my codebase?▼

Keeping your README in sync involves cross-referencing code diffs against your documentation files. This approach updates specified docs and optionally bumps the version to maintain accuracy post-code updates.

How does change logging work during post-ship documentation synchronization?▼

Change logging during documentation synchronization works by enhancing the CHANGELOG section with a polished voice. It ensures clear communication of updates and removes stale TODO entries from the documentation.

Can I automatically bump the version number when updating project documentation?▼

Yes, you can automatically bump the version number. After successfully updating documentation files to reflect codebase changes, the version bumping step executes optionally to keep versioning current.

Do I need Bash and Grep capabilities to clean up TODOs in my documentation?▼

Yes, Bash, Grep, Read, Write, Edit, Glob, and AskUserQuestion capabilities are required. These tools allow the process to read docs, find TODO entries, and remove them to maintain a professional look.