Align project documentation with shipped code changes after PR merges.
npx skills add https://github.com/Ulanxx/mzstack --skill document-release-ulanxx
Please help me install this Agent Skill. Skill: document-release Source: https://github.com/Ulanxx/mzstack/tree/main/document-release Command: npx skills add https://github.com/Ulanxx/mzstack --skill document-release-ulanxx
Post-ship documentation drift: after code ships, docs often become outdated. This skill reads project docs, cross-references diffs, updates READMEs, ARCHITECTURE docs, CONTRIBUTING, and CLAUDE.md to reflect what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION.
Run the document-release skill after a PR ships to automatically align documentation with the released changes.
High-intent search queries and answers about installing and using this skill.
To update README and ARCHITECTURE docs after a release, you can automate post-ship documentation alignment by cross-referencing code diffs to refresh shipped content. This ensures project docs accurately reflect the latest merged changes.
Preventing documentation drift involves automatically cross-referencing shipped code diffs with existing project docs. This process updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to ensure they match the released codebase.
Polishing a CHANGELOG and cleaning up TODOs after a version bump can be automated by refining the CHANGELOG voice and tidying TODO entries. This runs as part of a post-ship workflow to ensure clear release notes.
Yes, you can automatically bump the VERSION file when code is released. The post-ship documentation workflow includes conditional prompts for version changes, allowing an optional version bump after a PR is merged.
Post-ship documentation sync coordinates directly with your repo's git state and PR lifecycle. It enforces a plan-driven workflow with telemetry logging and contributor-mode hooks to update docs after a PR ships.
You should not automate post-ship documentation updates if your project lacks a plan-driven workflow or git state coordination. The process relies on cross-referencing diffs and requires telemetry logging and contributor-mode hooks to function correctly.
cegit27Synchronize markdown documentation with shipped code changes via git diffs.
filipnyquistRead ship diffs and update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.
fray-cloudAnalyze diffs against the base branch to surface structural issues.
balajivisUpdate project documentation to match shipped software changes and release status.
