massgen-release-documenter
Guide for following MassGen's release documentation workflow. This skill should be used when preparing release documentation, updating changelogs, writing case studies, or maintaining project documentation across releases.
Security Assessment
About massgen-release-documenter
The massgen-release-documenter skill is designed to guide users through the process of preparing release documentation for MassGen projects. It ensures that documentation remains consistent, complete, and follows the established workflow and conventions. This skill is particularly valuable for maintaining a well-documented release process, ensuring all necessary files and sections are updated and aligned with the project’s goals and standards. Whether updating changelogs, writing case studies, or maintaining README files, this skill facilitates efficient and organized release documentation management.
FAQ
When should I use the massgen-release-documenter skill?
You should use this skill when preparing documentation for a new release, updating the changelog, writing or updating Sphinx documentation, creating case studies for major features, updating README files, or following the release checklist process.
What is the authoritative source for the release documentation process?
The authoritative source is `docs/dev_notes/release_checklist.md`, which contains the complete phase-by-phase release workflow, detailed documentation update requirements, validation checklists, commit and tag workflows, and all conventions and rules.
What order should I follow when updating documentation?
Always follow this order: 1) CHANGELOG.md, 2) Sphinx Documentation, 3) Config Documentation, 4) Case Studies, 5) README.md, 6) README_PYPI.md, 7) Roadmap.
What should I do if the README_PYPI.md file is not synced automatically?
If the README_PYPI.md file is not synced automatically, you can manually sync it by running the command `uv run python scripts/sync_readme_pypi.py`.
Is there a specific documentation order that I must follow?
Yes, there is a specific order to follow when documenting a release. This order ensures that each phase of the documentation is updated properly before proceeding to the next.
Install massgen-release-documenter
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
massgen/MassGen