What problem does it solve?
This skill addresses the challenge of updating project documentation after new code or features have been shipped, ensuring that documentation remains current and aligned with the latest codebase.
Core Features & Use Cases
- Automated Documentation Update: Reads and cross-references project documentation with the code changes to ensure accuracy and consistency.
- Change Detection: Identifies updates required in various documentation files such as README, Architecture, Contributing, and CHANGELOG based on code changes.
- Version Bump Management: Optionally suggests and applies version bumps to the project's VERSION file when necessary.
- PR/MR Body Updates: Automatically updates the PR or MR body with documentation changes and identifies gaps in documentation coverage.
- Codex Documentation Review: Optionally performs an additional review of the documentation using Codex to ensure accuracy and completeness.
Quick Start
Use the document-release skill to update the project documentation after a code merge. Run the skill by entering: document-release update