document-release

Automating post-release documentation alignment involves auditing the release diff and applying updates to README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CHANGELOG.md. This ensures all shipped files accurately reflect the latest changes while preserving existing doc style.

Keeping a changelog and readme in sync with shipped code requires cross-referencing release diffs against project documentation. This approach applies idempotent edits and consistent styling across multiple core docs to accurately match what actually shipped.

Post-ship documentation alignment works by reading all project docs, cross-referencing them against the release diff, and applying corrections. It selectively updates scoped repository paths while preserving existing doc style across README, ARCHITECTURE, CONTRIBUTING, and CHANGELOG files.

Yes, you can update documentation for a specific repository scope. The documentation alignment process applies to the repository scope or repo path provided, allowing selective scope updates rather than forcing changes across the entire project.

Yes, you need diff data to synchronize documentation with shipped changes. The documentation alignment process requires access to diff data to audit what shipped and apply accurate updates to your core project files.

Automated documentation updates will not overwrite your existing doc style. The synchronization process preserves existing doc style while applying corrections, enforcing idempotent edits with consistent styling across multiple docs.