Skip to content

[docs] Self-healing documentation fix: update FAQ engine list - 2026-04-17#26872

Merged
pelikhan merged 1 commit intomainfrom
doc-healer/faq-engine-list-2026-04-17-cf41427ee32ada9a
Apr 17, 2026
Merged

[docs] Self-healing documentation fix: update FAQ engine list - 2026-04-17#26872
pelikhan merged 1 commit intomainfrom
doc-healer/faq-engine-list-2026-04-17-cf41427ee32ada9a

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Self-Healing Documentation Fixes

This PR was automatically created by the Daily Documentation Healer workflow.

Gaps Fixed

  • docs/src/content/docs/reference/faq.md line 334: The FAQ entry "I'm not using a supported AI Engine (coding agent)" listed only three engines (Copilot, Claude, Codex) but the current supported set is five: Copilot, Claude, Codex, Gemini, and Crush.

The same file already used the correct complete list at line 117:

"The dependencies: approach works with all supported engines (Copilot, Claude, Codex, Gemini, Crush)"

Root Cause

DDUw's code-change scan focuses on files modified in the PR diff. PRs that add new engines (Gemini, then OpenCode→Crush via #26819) updated the primary engine reference docs (engines.md, cli.md, environment-variables.md) but left this secondary mention in faq.md stale. DDUw's daily scan didn't catch this because the FAQ file had no recent commits — there was nothing in the PR diff to trigger a review of faq.md.

💡 DDUw Improvement Suggestions

DDUw Improvement Suggestions

When a new engine is added or renamed (identifiable by changes to pkg/constants/constants.go constants like CopilotEngine, ClaudeEngine, CodexEngine, GeminiEngine, or new *Engine constants), DDUw should:

  1. Search all documentation files for engine name lists using patterns like (Copilot, Claude or Copilot, Claude, Codex — these are high-value targets for staleness.
  2. Cross-check the list of engine names in those lines against the current set of *Engine constants in pkg/constants/constants.go and engine definitions in pkg/workflow/data/engines/.
  3. If any documented engine list is a strict subset of the current engine set, flag it as a gap.

This would have caught the stale faq.md:334 entry when the Gemini engine was added and again when Crush replaced OpenCode.

Related Issues

No direct issue reference — this gap was identified by cross-referencing the engine list in faq.md:117 against the same file's faq.md:334 and confirming via engines.md that Gemini and Crush are both current supported engines.

References:

Generated by Daily Documentation Healer · ● 508.5K ·

  • expires on Apr 20, 2026, 1:28 PM UTC

The FAQ entry "I'm not using a supported AI Engine" listed only three
engines (Copilot, Claude, Codex) but the current supported set is five:
Copilot, Claude, Codex, Gemini, and Crush. The Gemini engine was
previously added and the Crush engine replaced OpenCode in PR #26819
today. This line was not updated in either PR.

The same file already uses the complete five-engine list at line 117.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Apr 17, 2026
@pelikhan pelikhan marked this pull request as ready for review April 17, 2026 14:01
Copilot AI review requested due to automatic review settings April 17, 2026 14:01
@pelikhan pelikhan merged commit 4197437 into main Apr 17, 2026
3 checks passed
@pelikhan pelikhan deleted the doc-healer/faq-engine-list-2026-04-17-cf41427ee32ada9a branch April 17, 2026 14:01
Copy link
Copy Markdown
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

Updates a stale FAQ entry so the documentation reflects the current set of supported AI engines.

Changes:

  • Expanded the supported engine list in the FAQ from 3 engines to 5 (adding Gemini and Crush).
Show a summary per file
File Description
docs/src/content/docs/reference/faq.md Updates the FAQ’s supported engine list to match the current engine set.

Copilot's findings

Tip

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

  • Files reviewed: 1/1 changed files
  • Comments generated: 1

### I'm not using a supported AI Engine (coding agent). What should I do?

If you want to use a coding agent that isn't currently supported (Copilot, Claude, or Codex), you can contribute support to the [gh-aw repository](https://github.com/github/gh-aw), or open an issue describing your use case. See [AI Engines](/gh-aw/reference/engines/).
If you want to use a coding agent that isn't currently supported (Copilot, Claude, Codex, Gemini, or Crush), you can contribute support to the [gh-aw repository](https://github.com/github/gh-aw), or open an issue describing your use case. See [AI Engines](/gh-aw/reference/engines/).
Copy link

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

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

The parenthetical list after “isn't currently supported” reads as if Copilot/Claude/Codex/Gemini/Crush are the unsupported engines, which is the opposite of what this FAQ intends. Reword to make it unambiguous (e.g., “...that isn't currently supported (i.e., not one of Copilot, Claude, Codex, Gemini, or Crush) ...” or “...other than Copilot, Claude, Codex, Gemini, or Crush ...”).

Suggested change
If you want to use a coding agent that isn't currently supported (Copilot, Claude, Codex, Gemini, or Crush), you can contribute support to the [gh-aw repository](https://github.com/github/gh-aw), or open an issue describing your use case. See [AI Engines](/gh-aw/reference/engines/).
If you want to use a coding agent that isn't currently supported (that is, not one of Copilot, Claude, Codex, Gemini, or Crush), you can contribute support to the [gh-aw repository](https://github.com/github/gh-aw), or open an issue describing your use case. See [AI Engines](/gh-aw/reference/engines/).

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

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants