massgen-release-documenter
Automates and manages the MassGen release documentation lifecycle, ensuring compliance with release checklists, changelog maintenance, and automated syncs.
Introduction
The massgen-release-documenter is a specialized agent skill designed to streamline the technical release process for the MassGen framework. It provides a structured, authoritative workflow for developers to ensure that every software release is accompanied by comprehensive, high-quality documentation. By standardizing the release path, the skill minimizes human error during the complex orchestration of updating changelogs, Sphinx-based technical documentation, configuration references, and roadmap files.
This skill is intended for software engineers and maintainers working within the MassGen repository. It is particularly valuable during the final stages of the development cycle, where consistency across project artifacts—including READMEs, PyPI-synced documentation, and detailed case studies—is mission-critical for user adoption and ecosystem transparency. The agent enforces a strict dependency order to ensure that upstream changes in code are accurately reflected in downstream documentation outputs.
-
Orchestrates a multi-phase release workflow following the canonical docs/dev_notes/release_checklist.md.
-
Facilitates the systematic generation and updates of CHANGELOG.md, Sphinx source files, and configuration documentation.
-
Integrates with pre-commit hooks to automate the synchronization of README.md and README_PYPI.md files.
-
Supports the creation and templating of project case studies, helping to document complex agentic workflows and model integrations.
-
Provides clear validation steps for Sphinx documentation builds, link checking, and roadmap status updates.
-
Manages the transition of version-specific release announcements, including support for social media content generation via integrated tools.
-
Always initialize the release process by updating the CHANGELOG.md and consulting the authoritative release_checklist.md.
-
Use this skill to verify that backend changes in config_builder.py and capabilities.py are documented whenever YAML schemas or model support evolve.
-
Ensure that all build artifacts are verified using make html and make linkcheck commands provided by the tool.
-
Leverage the automation-first approach to reduce manual overhead in project maintenance and technical writing.
-
Note that this skill requires consistent access to repository roots and documentation directories to perform file-system operations and validation checks.
Repository Stats
- Stars
- 967
- Forks
- 151
- Open Issues
- 6
- Language
- Python
- Default Branch
- main
- Sync Status
- Idle
- Last Synced
- Apr 28, 2026, 01:25 PM