skills.rest
soyasis
soyasisCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Scan diffs and apply updates across multi-file documentation after releases.

Updated Mar 13, 2026
Search Tags:#automation#versioning#documentation#quality#docs#diff-analysis
One-click install
npx skills add https://github.com/soyasis/gstack-private --skill document-release-soyasis
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/soyasis/gstack-private/tree/main/document-release
Command: npx skills add https://github.com/soyasis/gstack-private --skill document-release-soyasis

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the laborious task of updating project documentation after releases by scanning diffs and applying changes across multiple docs.

Core Features & Use Cases

  • Auto-sync docs across multiple files based on PR diff
  • Proactively polish CHANGELOG and TODOS
  • Optional version bump and telemetry prompts as configured

Quick Start

Run the document-release workflow on your feature branch to update docs to match 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 across multiple files after shipping code?▼

Automate documentation updates by scanning PR diffs and applying changes across multi-file ecosystems like README and ARCHITECTURE. This keeps docs in sync with shipped changes without manual edits.

What is the best way to keep a README and CONTRIBUTING file in sync with code changes?▼

Keeping docs in sync relies on diff-analysis to detect shipped code changes and automatically apply updates across core files. It targets multi-file doc ecosystems to ensure metadata presence and alignment.

How do I automatically polish a CHANGELOG and TODOS based on a PR diff?▼

You can proactively polish CHANGELOG and TODOS by running a diff-analysis workflow on your feature branch. This detects shipped changes and applies updates to keep documentation aligned.

Does this docs automation workflow support optional version bumps and telemetry prompts?▼

Yes, the docs automation workflow enforces safe governance with optional version bumps and telemetry prompts as configured. This ensures metadata presence while managing release documentation updates.

When do I need to run a diff-analysis workflow for documentation alignment?▼

Run a diff-analysis workflow for documentation alignment after shipping code on your feature branch. It scans diffs to apply updates across core docs, ensuring project documentation matches the shipped changes.

Can I use this workflow to enforce metadata presence in a multi-file doc ecosystem?▼

Yes, you can enforce metadata presence across a multi-file doc ecosystem using this automation workflow. It scans diffs and applies updates to core docs while enforcing safe governance during the release process.

Related Skills

Explore More Content & Communication Skills→
nillenille

Code Review

Review code diffs for correctness, security, and conventions.

Community
Advanced
jonaseck2jonaseck2
2

oss-release

Enforce CHANGELOG.md release-note structure with a 10-block rolling window.

Community
Intermediate
AndrewDrygaAndrewDryga
28

release

Create semantic version tags from changelogs and push them to Git.

Community
Advanced
SeaLion-hubSeaLion-hub

document-release

Update project docs from diffs after code ships.

Community
Advanced