Synchronize project documentation with shipped code using git diffs.
npx skills add https://github.com/a29paul/hexlens --skill document-release-a29paul
Please help me install this Agent Skill. Skill: document-release Source: https://github.com/a29paul/hexlens/tree/main/.claude/skills/gstack/document-release Command: npx skills add https://github.com/a29paul/hexlens --skill document-release-a29paul
After shipping code, project documentation (READMEs, changelogs, architecture guides, etc.) often falls out of sync with what was actually deployed, leading to confusion for users and contributors, wasted time debugging mismatched docs, and reduced trust in project resources.
Use the document-release skill to sync all project documentation with the code changes from your latest shipped PR.
High-intent search queries and answers about installing and using this skill.
Automating post-ship documentation synchronization cross-references git diffs to identify shipped changes and updates README and changelog files to match the deployed functionality. It eliminates stale project docs by aligning supporting documentation with the latest code deployments.
Syncing project documentation with a git diff involves cross-referencing the shipped code changes to identify required updates in supporting files. This process automatically aligns READMEs, architecture docs, and contribution guides with the actual deployed code.
Yes, you can automatically clean up outdated TODOs in your documentation after a release. Post-ship doc synchronization tools identify resolved issues from git diffs and remove the corresponding outdated TODO notes from your project files.
Yes, post-ship documentation synchronization works for architecture docs and contribution guides. It updates multiple documentation files including README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to accurately reflect newly shipped functionality.
To bump version numbers in project files to match a new release, you can use an automated post-ship documentation tool. It optionally increments version numbers across project files while synchronizing your changelog and README with the latest git changes.
You should avoid using automated doc alignment when a software project has no shipped code changes or lacks existing documentation files to sync. The tool requires a git diff from a recent deployment to identify changes and update relevant project docs.
SeaLion-hubUpdate project docs from diffs after code ships.
k2worksAutomate release workflows with preflight checks, semantic version bumps, changelogs, and git tags.
luisgustavooliveiraSynchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped code using Git.
diiviikk5Sync post-ship diffs across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.
