[docs] docs: consolidate repetitive engine sections in engines.md#19779
[docs] docs: consolidate repetitive engine sections in engines.md#19779
Conversation
Replace four identical "Using X" sections with a concise table, removing ~46 lines of bloated repetitive content while preserving all links, frontmatter values, and auth doc references. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Consolidates the AI engine selection documentation by replacing repetitive per-engine “Using X” sections with a single comparison table, and updates internal links that referenced the removed anchors.
Changes:
- Replaced four near-identical “Using …” sections in
engines.mdwith a single engine/secret comparison table. - Trimmed redundant explanatory bullets in
engines.md(args/common uses, command path formats, duplicated “default” notes). - Updated internal links in
auth.mdxandfaq.mdto point at the new#available-coding-agentsanchor.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/src/content/docs/reference/engines.md | Consolidates engine setup into a single table and removes duplicated/redundant sections. |
| docs/src/content/docs/reference/auth.mdx | Updates “See also” links to the new engines anchor after section removal. |
| docs/src/content/docs/reference/faq.md | Fixes a reference link to the engines page after anchor removal. |
Comments suppressed due to low confidence (2)
docs/src/content/docs/reference/auth.mdx:112
- This link text claims the AI Engines page contains “additional configuration needed when using Claude with GitHub MCP”, but that section now only lists engines/secrets and doesn’t describe MCP-specific setup. Update the link target (e.g., to the MCP guide / Tools docs) or adjust the sentence so it doesn’t promise content that isn’t present.
See also [AI Engines](/gh-aw/reference/engines/#available-coding-agents) for additional configuration needed when using Claude with GitHub MCP.
docs/src/content/docs/reference/auth.mdx:130
- This “See also” sentence says the AI Engines page provides “additional configuration needed when using Codex with GitHub MCP”, but the engines page no longer includes MCP-specific configuration details. Either point to the MCP/Tools documentation that covers that setup, or reword this so it’s not misleading.
See also [AI Engines](/gh-aw/reference/engines/#available-coding-agents) for additional configuration needed when using Codex with GitHub MCP.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| ``` | ||
|
|
||
| See also [Using Gemini](/gh-aw/reference/engines/#using-google-gemini-cli) for additional configuration needed when using Gemini with GitHub MCP. | ||
| See also [AI Engines](/gh-aw/reference/engines/#available-coding-agents) for additional configuration needed when using Gemini with GitHub MCP. |
There was a problem hiding this comment.
This “See also” line implies the AI Engines page includes “additional configuration needed when using Gemini with GitHub MCP”, but the engines page doesn’t describe MCP-specific setup anymore. Please either link directly to the MCP/Tools docs that cover the configuration, or soften the wording to match what the target page actually contains.
This issue also appears in the following locations of the same file:
- line 112
- line 130
| Set `engine:` in your workflow frontmatter and configure the corresponding secret: | ||
|
|
There was a problem hiding this comment.
The guidance is slightly self-contradictory: it says to set engine: in workflow frontmatter, but a few lines later notes engine: can be omitted for Copilot (the default). Consider rephrasing to clarify that engine: is optional and only required when selecting a non-default engine, while the secret still must be configured.
Cleans up
docs/src/content/docs/reference/engines.mdby replacing four near-identical "Using X" sections with a single comparison table.What changed
File improved:
docs/src/content/docs/reference/engines.mdBloat removed:
Supporting fixes (broken links from removed anchors):
auth.mdxfrom old section anchors to#available-coding-agentsfaq.mdfrom old section anchor to#available-coding-agentsMetrics
Build verification
✅
npm run buildpasses withAll internal links are valid.Screenshots
Screenshots could not be captured in this run — Playwright was unable to connect to the local preview server due to the network sandbox/firewall constraints in this environment.
References: §22742422309
✨ PR Review Safe Output Test - Run 22743892947