Feature Request: Self Healing Updates to Fix Documentation Workflow issues #18372
Closed as not planned
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 is not perfect and needs continuous improvement. A workflow should also recognize need for DDUw improvement when outdated information or documentation gaps have valid reported issues (including when an recent changes or merged PRs are linked to 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:
- 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:
- Closes the gap between user-reported documentation problems and automated correction.
See example outdated info/issue:
Tags: automation, documentation