document-release

To update README and ARCHITECTURE docs after a code release, you can automate cross-referencing shipped diffs with project documentation. This ensures public docs align with the latest changes by suggesting targeted edits and preventing unintended content drift.

The best way to keep project documentation aligned is to run an automated post-ship workflow that scans diffs and cross-references them against README, ARCHITECTURE, and CONTRIBUTING files. This prevents narrative drift and enforces doc integrity automatically.

Yes, you can automatically polish the voice in your CHANGELOG without altering factual content. The workflow updates tone and consistency across release notes while preserving the original factual changes pulled from the shipped code diffs.

Cross-referencing diffs prevents unintended content changes by comparing shipped code modifications against existing documentation files like AGENTS.md. It enforces doc integrity by suggesting precise edits and flagging discrepancies before updates are finalized.

You need to update documentation files immediately after shipping code to prevent post-ship doc drift. Running an automated workflow refreshes README, ARCHITECTURE, and CONTRIBUTING files so project communications stay accurate and matched to the release.

Yes, the documentation update workflow works for PR reviews and release notes by optionally bumping or flagging documentation updates. It aligns public docs with shipped changes, ensuring review processes catch narrative inconsistencies.