skills.rest
Manzueti
ManzuetiCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project documentation files after software deployments using bash, grep, and glob.

Updated Jun 4, 2026
Search Tags:#markdown#code synchronization#document update#project maintenance#post-ship
One-click install
npx skills add https://github.com/Manzueti/cyberdart --skill document-release-manzueti
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Manzueti/cyberdart/tree/main/document-release
Command: npx skills add https://github.com/Manzueti/cyberdart --skill document-release-manzueti

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires bash, grep, glob, and includes scripts (resource) components.

What problem does it solve?

This Skill simplifies post-ship documentation updates, ensuring README, Architecture, CONTRIBUTING, and CLAUDE.md are synchronized with the latest shipped version.

Core Features & Use Cases

  • Automated Documentation Updates: Synchronizes README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match shipped code changes.
  • Proactive Updates: Suggests updates after merging PRs or shipping code, reducing manual effort.
  • Use Case: After merging a feature branch into the main branch, use this Skill to automatically update documentation and generate a polished CHANGELOG.

Quick Start

Run the document-release skill to update documentation after a merge or ship event.

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 code deployment?▼

Automating documentation updates after a code deployment requires parsing file differences to align README and contributing guidelines with the latest codebase changes. This Skill synchronizes project documentation automatically after merging feature branches or shipping code.

How do I keep my README and CONTRIBUTING files synchronized with shipped code?▼

Keeping README and CONTRIBUTING files synchronized with shipped code involves matching documentation content to the latest codebase changes. This Skill parses file differences using bash, grep, and glob to update relevant documentation files proactively after merges.

Do I need bash and grep to update project documentation automatically?▼

Yes, updating project documentation automatically with this Skill requires bash, grep, and glob commands for parsing file differences. These dependencies are necessary to detect codebase changes and apply the corresponding updates to markdown documentation files.

What is the best way to generate a CHANGELOG after merging a feature branch?▼

Generating a CHANGELOG after merging a feature branch is best handled by automating the update of project documentation to match shipped code changes. This Skill suggests proactive updates after merges, reducing manual effort and generating a polished changelog.

Can I update ARCHITECTURE and CLAUDE.md files automatically after a release?▼

Yes, updating ARCHITECTURE and CLAUDE.md files automatically after a release is supported by this Skill. It synchronizes these specific markdown documentation files to match the latest shipped version, ensuring project documentation remains aligned with the codebase.

Related Skills

Explore More Software Engineering Skills→
ghalacticghalactic

vale-style-authoring-guides

Document Vale regex syntax, glob patterns, Hunspell dictionaries, and LSP integration.

Official
Advanced
him55710-sudohim55710-sudo

document-release

Update README, ARCHITECTURE, and CLAUDE.md entries from ship diffs.

Community
Advanced
VMRam95VMRam95

agentlens

Analyze directory structures and source code to generate hierarchical documentation and architectural maps.

Community
Intermediate
channgchanng
20

docsify

Generate static documentation websites from markdown files with sidebar navigation.

Community
Basic