document-release

Name: document-release
Availability: InStock
Author: limzivector

Automate post-ship documentation updates to reflect codebase changes.

Updated May 28, 2026

Search Tags:#versioning #documentation #codebase #post-ship #PR updates

Ready to run

npx skills add https://github.com/limzivector/SEO --skill document-release-limzivector

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, github, gitlab, python, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the post-ship documentation update process, ensuring that the documentation reflects the latest changes in the codebase.

Core Features & Use Cases

Documentation Audit: Audits all documentation files against the codebase changes to ensure consistency and completeness.
Auto-Updates: Applies factual corrections to documentation based on the code changes.
Risk Assessment: Flags and prompts for review of risky or questionable changes.
Voice Polish: Refines the voice of the CHANGELOG to better communicate the value of the changes.
Cross-Doc Consistency: Ensures all documentation files are consistent and discoverable.
VERSION Bump: Optionally updates the version number in the VERSION file.
Commit & PR Update: Updates the commit message and PR body to include documentation changes.
Codex Documentation Review: Optionally runs a Codex review against the documentation for additional validation.

Quick Start

Run the 'document-release' skill to update the documentation post-ship. Example command: /document-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 shipping code changes?▼

Automating documentation updates post-ship involves auditing documentation files against codebase changes to apply factual corrections, flag risky modifications, and update commit messages. This requires a Python environment to execute file system operations and git for tracking changes.

What is the best way to keep project documentation consistent with the codebase?▼

Keeping project documentation consistent with the codebase requires auditing all documentation files against codebase changes, applying factual corrections, and ensuring cross-doc consistency so all files remain discoverable and aligned with the latest updates.

Can I update GitHub or GitLab PR bodies with documentation changes automatically?▼

Yes, you can update GitHub or GitLab PR bodies automatically. The post-ship documentation process updates the commit message and PR body to include documentation changes, utilizing git for tracking and GitHub or GitLab for PR updates.

Do I need a Python environment to run post-ship documentation scripts?▼

Yes, you need a Python environment to run post-ship documentation scripts. The scripts require Python for executing file system operations, handling documentation audits, and applying factual corrections based on codebase changes.

How does post-ship documentation handling assess the risk of codebase changes?▼

Post-ship documentation handling assesses the risk of codebase changes by flagging and prompting for review of risky or questionable modifications. It audits documentation against the codebase to ensure consistency and completeness before applying corrections.