Uh oh!
There was an error while loading. Please reload this page.
[docs] Self-healing documentation fix: update FAQ engine list - 2026-04-17 - #26872
Conversation
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>
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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/). |
There was a problem hiding this comment.
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 ...”).
| 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/). |
Self-Healing Documentation Fixes
This PR was automatically created by the Daily Documentation Healer workflow.
Gaps Fixed
docs/src/content/docs/reference/faq.mdline 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:
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 infaq.mdstale. 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 offaq.md.💡 DDUw Improvement Suggestions
DDUw Improvement Suggestions
When a new engine is added or renamed (identifiable by changes to
pkg/constants/constants.goconstants likeCopilotEngine,ClaudeEngine,CodexEngine,GeminiEngine, or new*Engineconstants), DDUw should:(Copilot, ClaudeorCopilot, Claude, Codex— these are high-value targets for staleness.*Engineconstants inpkg/constants/constants.goand engine definitions inpkg/workflow/data/engines/.This would have caught the stale
faq.md:334entry 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:117against the same file'sfaq.md:334and confirming viaengines.mdthat Gemini and Crush are both current supported engines.References: