Feature Request: Auto-flag or Suggest Updates to Documentation for Outdated Information #18371
Description
Feature Request: Auto-flag or Suggest Updates to Documentation for Outdated Information
Background:
The DDUw (Daily Documentation Updater workflow) (.github/workflows/daily-doc-updater.md) currently reviews repo changes and docs, but it should also recognize outdated information or documentation gaps when changes are made to code/test files and either flag or suggest an update automatically.
Example case:
- Update docs/help text: init/upgrade/fix no longer create
.github/awprompt files #18202 is a clear instance where the workflow should have identified outdated doc/help text (e.g., files claiming CLI creates prompt files that are now managed elsewhere) and prompted/suggested a correction or PR. This information was not flagged nor corrected by the workflow.
Requested enhancement:
- Enhance the DDUw (Daily Documentation Updater workflow) to detect recent behavior changes by analyzing executable code (ignore comments), then corroborating expected behavior via tests. Based on that, the workflow should identify documentation mismatches (repo Markdown + code comments) and either:
- prompt/suggest the necessary documentation updates, or
- automatically open a PR when confidence is high and changes are straightforward.
- Note: DDUw must not treat existing docs or comments as authoritative sources of truth.
Benefits:
- Keeps documentation accurate, reduces lag time for doc corrections after code changes.
See example outdated info/issue:
Tags: automation, documentation