Skip to content

Add Daily Documentation Healer workflow (self-healing DDUw companion)#18375

Merged
pelikhan merged 4 commits intomainfrom
copilot/feature-self-healing-updates
Feb 26, 2026
Merged

Add Daily Documentation Healer workflow (self-healing DDUw companion)#18375
pelikhan merged 4 commits intomainfrom
copilot/feature-self-healing-updates

Conversation

Copy link
Contributor

Copilot AI commented Feb 25, 2026

  • Create .github/workflows/daily-doc-healer.md - self-healing documentation workflow
  • Compile the workflow to .github/workflows/daily-doc-healer.lock.yml
  • Add workflow entry to docs/src/content/docs/agent-factory-status.mdx
  • Use daily cron shorthand (matching DDUw style) instead of explicit cron expression
  • Remove reviewers, draft, and auto-merge from create-pull-request safe-output config
Original prompt

This section details on the original issue you should resolve

<issue_title>Feature Request: Self Healing Updates to Fix Documentation Workflow issues</issue_title>
<issue_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:

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/aw prompt 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</issue_description>

Comments on the Issue (you are @copilot in this section)

@pelikhan Low quality.

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add self healing updates for documentation workflow Add Daily Documentation Healer workflow (self-healing DDUw companion) Feb 25, 2026
on:
schedule:
# Every weekday at 8am UTC (after DDUw runs at ~3am)
- cron: "0 8 * * 1-5"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot daily

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to cron: daily shorthand (matching DDUw style) in c87caf7.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@jeremiah-snee-openx
Copy link

@pelikhan copilot-setup-steps looks to be failing from missing dependency.

@github-actions
Copy link
Contributor

Hey @Copilot 👋 — thanks for putting together the Daily Documentation Healer workflow! The idea of a self-healing companion to DDUw is genuinely interesting, and the implementation looks thorough. However, there's a process issue that needs to be resolved before this can move forward.

⚠️ Process Concern — Source Issue Was Rejected

This PR fixes #18372, which was:

  • Labeled spam by the core team
  • Closed as not_planned by @pelikhan with the comment "Low quality."

The CONTRIBUTING.md is clear that the core team reviews and approves issues before implementation begins. Implementing work rooted in a rejected, spam-labeled issue is a process violation — regardless of who (or what) created the PR.

It appears this PR may have been triggered automatically rather than as the result of a deliberate core-team decision to pick up this work. The community member who filed the issue noted they had triggered too many workflows and were getting rate-limited, which suggests this was an inadvertent automation trigger rather than an intentional assignment.

Other Findings

Check Result
On-topic ✅ Adds a new agentic workflow — aligns with project focus
Focused ✅ Three files, single clear purpose
New dependencies ✅ None
Has description ✅ PR body includes checklist and issue reference
Has tests ❌ No test files included
Lines changed 1,611

Missing tests: Workflow definitions in this repo are typically validated via CI (make agent-finish). The PR comment notes a failing copilot-setup-steps step, suggesting the workflow itself may have issues that need fixing before it could be accepted.

Recommended Path Forward

  1. Check whether this work was intentionally assigned — if @pelikhan did not deliberately intend to implement Feature Request: Self Healing Updates to Fix Documentation Workflow issues #18372, this PR should be closed.
  2. If the feature is wanted, a new, higher-quality issue should be opened and explicitly approved by a core team member before re-implementing.
  3. Fix the CI failure reported in the PR comments (missing dependency in copilot-setup-steps).

If you'd like to address the above and re-attempt once the issue is properly approved, here's a prompt you can use:

The PR github/gh-aw#18375 (Daily Documentation Healer) was flagged because it implements a rejected issue (#18372, labeled spam/not_planned).

Please do the following:
1. Check with the core team whether this workflow is actually desired. If yes, ensure a new, approved issue exists with a detailed agentic plan.
2. Investigate and fix the CI failure in the copilot-setup-steps job (see: https://github.com/github/gh-aw/actions/runs/22406316814/job/64867044831#step:36:52).
3. Once CI passes, ensure `make agent-finish` runs cleanly (build, test, lint, recompile).
4. If applicable, add any workflow-level tests or validation steps that follow the patterns used by other workflows in .github/workflows/.

Generated by Contribution Check

Comment on lines 28 to 30
reviewers: [copilot]
draft: false
auto-merge: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot remove

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed reviewers, draft, and auto-merge from the create-pull-request safe-output in aaeab00.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan pelikhan marked this pull request as ready for review February 26, 2026 02:40
Copilot AI review requested due to automatic review settings February 26, 2026 02:40
@pelikhan pelikhan merged commit bbb769d into main Feb 26, 2026
2 checks passed
@pelikhan pelikhan deleted the copilot/feature-self-healing-updates branch February 26, 2026 02:40
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new “Daily Documentation Healer” companion workflow intended to detect documentation gaps missed by the existing Daily Documentation Updater (DDUw) and to propose corrective documentation/heuristic updates.

Changes:

  • Introduces a new agentic workflow definition for “Daily Documentation Healer” and compiles it to a locked GitHub Actions workflow.
  • Configures safe-output behaviors for creating PRs/issues (without reviewers/draft/auto-merge settings).
  • Updates the agent factory status documentation to include the new workflow entry.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
docs/src/content/docs/agent-factory-status.mdx Adds the new workflow to the published workflow/status table.
.github/workflows/daily-doc-healer.md Defines the new healer workflow prompt/instructions, tools, and safe-outputs configuration.
.github/workflows/daily-doc-healer.lock.yml Generated locked workflow YAML compiled from the new .md workflow.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


For each issue found:
- Record the issue number, title, body, and closing date.
- Check whether a DDUw-created PR (label `documentation automation`, title prefix `[docs]`) was merged that references or addresses the issue in the same time window. If such a PR exists, DDUw likely already handled it — skip this issue.
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workflow text treats documentation automation as a single label when checking for DDUw-created PRs. In this repo the safe-outputs configuration applies two separate labels (documentation and automation), so a GitHub search using label:"documentation automation" would not match. Update this step to check for both labels (e.g., label:documentation label:automation) or rely on the [docs] title prefix + author/bot label combination.

Suggested change
- Check whether a DDUw-created PR (label `documentation automation`, title prefix `[docs]`) was merged that references or addresses the issue in the same time window. If such a PR exists, DDUw likely already handled it — skip this issue.
- Check whether a DDUw-created PR (labels `documentation` and `automation`, title prefix `[docs]`) was merged that references or addresses the issue in the same time window (for example, using a search like `label:documentation label:automation`). If such a PR exists, DDUw likely already handled it — skip this issue.

Copilot uses AI. Check for mistakes.
Comment on lines +99 to +101
```bash
find docs/src/content/docs -name '*.md' -o -name '*.mdx'
```
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The bash command suggested here (find docs/src/content/docs ...) is not included in this workflow’s bash allowlist (which currently only allows find docs -name '*.md' -o -name '*.mdx'). In strict mode this is likely to be blocked at runtime. Either adjust the instructions to use the allowed find docs ... command, or add the find docs/src/content/docs -name '*.md' -o -name '*.mdx' variant to the tools.bash allowlist.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature Request: Self Healing Updates to Fix Documentation Workflow issues

4 participants