document-release

Update project documentation files after merged PRs using a frontmatter-driven workflow.

Updated Mar 25, 2026
One-click install
npx skills add https://github.com/Batsirai/adoro-studios --skill document-release-batsirai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Batsirai/adoro-studios/tree/main/Skills/document-release
Command: npx skills add https://github.com/Batsirai/adoro-studios --skill document-release-batsirai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates post-ship documentation updates across project docs to keep them aligned with shipped changes.

Core Features & Use Cases

  • Automatically updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the latest code changes.
  • Cleans up TODOS, polishes CHANGELOG voice, and optionally bumps VERSION after merges.
  • Provides a repeatable frontmatter-driven workflow and supports optional resource directories for scripts, references, or assets.

Quick Start

Run the document-release workflow after a PR is merged to sync all project documentation with the shipped changes.

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 PR merge?

Automating documentation updates after a PR merge involves running a post-ship workflow that syncs README, ARCHITECTURE, and CONTRIBUTING files with shipped code changes. It applies frontmatter-driven rules to make safe, incremental edits and commits them directly to version control.

What is a frontmatter-driven workflow for keeping docs in sync with code?

A frontmatter-driven workflow for documentation sync uses metadata headers to define repeatable update rules across project docs. It enforces consistent post-ship edits to specific sections and files, ensuring documentation stays aligned with merged code changes.

How do I keep my CHANGELOG and README aligned with shipped code changes?

Keeping your CHANGELOG and README aligned with shipped code changes requires an automated post-ship process that polishes changelog voice, cleans up TODOs, and updates documentation sections to reflect the latest merged features or fixes.

Can I use incremental version-controlled commits for documentation versioning?

Yes, you can use incremental version-controlled commits for documentation versioning. This approach applies safe, isolated edits to docs like CLAUDE.md and README after merges, ensuring all changes are tracked and reversible without overwriting existing content.

What is the best way to update ARCHITECTURE and CONTRIBUTING docs after shipping?

The best way to update ARCHITECTURE and CONTRIBUTING docs after shipping is automating the post-ship documentation workflow. It targets multiple files and sections simultaneously, applying repeatable edits to reflect structural code changes and contribution guidelines accurately.

Does this documentation automation work without external dependencies?

Yes, this documentation automation works without external dependencies. It operates independently to update project docs and bump versions using a self-contained, frontmatter-driven workflow that manages safe edits through version-controlled commits.