documentation-automation

Update CHANGELOG.md, README sections, and inline code docs.

34|6|Updated Dec 19, 2025

Search Tags:#automation #documentation #TypeScript #Rust #README #CHANGELOG #inline-docs

One-click install

npx skills add https://github.com/ecto/muni --skill documentation-automation

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: documentation-automation
Source: https://github.com/ecto/muni/tree/main/.claude/skills/documentation-automation
Command: npx skills add https://github.com/ecto/muni --skill documentation-automation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill proactively maintains project documentation across CHANGELOG.md, README sections, and inline code docs, saving engineers from manual, error-prone updates.

Core Features & Use Cases

CHANGELOG automation: Writes conventional-commit style entries to CHANGELOG.md with file references.
README enrichment: Updates root and subsystem READMEs with new features, usage examples, and migration notes.
Inline documentation: Generates code comments and doc blocks for new APIs in Rust and TypeScript, with safety notes.
Cross-references: Updates references across CLAUDE.md and related docs.

Quick Start

Run the Documentation Automation Skill after implementing a feature to ensure all documentation is up to date. For example, after merging a PR that adds a new API, trigger the skill to update CHANGELOG.md, add README sections, and generate inline docs.