Enhance Daily Documentation Updater: Automatically flag/suggest update to docs for outdated info & open doc issues #18204
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 (including when an open GitHub issue like #18202 exists for incorrect/incomplete docs) 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.
-
Make DDUw self-healing (or add a companion workflow) that treats documentation issues (e.g., Update docs/help text: init/upgrade/fix no longer create
.github/awprompt files #18202) as signals of DDUw failure and triggers corrective behavior:- Detect when recent changes reference/link to documentation issues, and also periodically cross-reference recently closed documentation issues against recent code changes to find documentation DDUw missed.
- For each detected signal/miss: analyze the issue + associated code changes + current DDUw logic to determine the most likely root cause (require high certainty before acting).
- Once the cause is determined, apply the same outcome as above: prompt/suggest the doc update or open a PR automatically if feasible.
- Propose updates to DDUw rules/heuristics (and/or open a PR for the workflow itself) so the miss is less likely to recur.
Benefits:
- Keeps documentation accurate, reduces lag time for doc corrections after code changes.
- Closes the gap between user-reported documentation problems and automated correction.
See example outdated info/issue:
Tags: automation, documentation