document-release

Automating documentation updates after shipping involves using git diff to identify changed files and applying predefined heuristics to update README, Architecture, and Change Log files. This ensures your project documentation remains consistent with the latest codebase without manual intervention.

Keeping a Change Log consistent with version control involves cross-referencing code changes against existing documentation and refining the log's voice. The process automatically polishes entries to maintain a friendly, informative tone while reflecting recent git diff changes.

Cross-referencing code changes against existing documentation works by comparing git diff output with current README, Architecture, and Contributing files. It identifies discrepancies where documentation no longer matches the codebase and applies predefined heuristics to update the affected sections.

Yes, you can clean up outdated TODO items by analyzing recent code changes to identify completed tasks. The process removes obsolete entries from TODOS.md and suggests new TODO items based on the functionality introduced in the latest shipped code.

No, you do not need to manually trigger a version bump. The documentation update process prompts you to consider a version bump based on the analyzed code changes, allowing you to decide and apply the bump through user input.

Limitations of synchronizing documentation with predefined heuristics include reliance on git diff accuracy for file identification and the scope of updates being restricted to README, Architecture, Contributing, Change Log, and TODOS.md files, requiring manual review for complex architectural shifts.