document-release

Automate documentation updates by reading project files, detecting shipped changes, and modifying relevant documentation. This ensures README, architecture, and contributing files reflect the latest code modifications automatically without manual intervention.

Detect project changes for post-ship documentation by analyzing the codebase after a ship event. The process identifies what has changed and updates relevant files accordingly, highlighting any resulting documentation debt in the PR body for future reference.

Keep README and architecture files in sync by running an automated post-ship update process. This reads project documentation, detects changes from the merged PR, and edits relevant files to ensure all information is accurate and up-to-date.

Highlight documentation debt in a PR body automatically by using a post-ship documentation update workflow. The process detects missing or outdated documentation resulting from shipped changes and notes this debt directly in the PR body for tracking.

You need Bash, Glob, Read, Write, Edit, Grep, and AskUserQuestion tools to automate project documentation updates. These dependencies allow the workflow to scan files, detect changes, prompt for input, and modify documentation automatically.

Run an automated documentation update after merging a PR and shipping new code. This post-ship timing ensures all relevant documentation is synchronized with the latest changes before the codebase is used or reviewed further.