[docs] docs(engines): reduce bloat in AI engines reference#25010
Merged
[docs] docs(engines): reduce bloat in AI engines reference#25010
Conversation
- Replace 4 separate version-pinning code blocks with a summary table and a single illustrative example; eliminates redundant boilerplate - Remove duplicate GHEC api-target code block that was identical to the labeled GHEC example immediately below it - Condense Copilot Custom Configuration section; move the .agent.md extension note inline as a code comment Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
github-actions
bot
added
automation
documentation
pelikhan
approved these changes
Apr 7, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Reduces redundancy and overall length of the AI engines reference documentation by consolidating repeated examples and tightening explanatory text.
Changes:
- Replaced four near-identical version pinning examples with a compact reference table plus a single example snippet.
- Condensed the Copilot custom agent (
engine.agent) explanation and embedded the extension detail inline. - Removed a duplicated, unlabeled Enterprise API Endpoint example block so the labeled examples are the first illustration.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/reference/engines.md | Consolidates repeated engine configuration examples and tightens prose to reduce doc bloat. |
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
Comment on lines
+64
to
+67
| | GitHub Copilot CLI | `copilot` | `"0.0.422"` | | ||
| | Claude Code | `claude` | `"2.1.70"` | | ||
| | Codex | `codex` | `"0.111.0"` | | ||
| | Gemini CLI | `gemini` | `"0.31.0"` | |
There was a problem hiding this comment.
In the version pinning table, the Example version cells include backslashes (e.g., \"0.0.422\"). Inside inline code, quotes don’t need escaping, so the backslashes will render literally and look wrong. Remove the backslashes so the table shows the version string as "0.0.422" (without backslashes).
This was referenced Apr 7, 2026
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reduces redundancy in
docs/src/content/docs/reference/engines.md(280 → 258 lines, −22 lines).Changes
Removed duplicate code block: The "Enterprise API Endpoint" section contained an unlabeled code block identical to the immediately following "GHEC example" block. Removed the redundant intro block; the labeled examples now serve as the first illustration.
Version pinning table: Replaced 4 separate
yaml wrapcode blocks (one per engine) with a compact reference table plus a single illustrative example. The 4 blocks were structurally identical and only differed inidandversionvalues.Condensed Copilot Custom Configuration: The description was two paragraphs explaining the
agentfield. Condensed to one sentence with the.agent.mdextension note moved inline as a code comment; link text shortened from "for details on creating and configuring custom agents" to "for details".Metrics
Issues
Screenshots were unavailable: Playwright could not connect to the docs server due to network isolation between the agent container and Playwright container (known AWF network configuration constraint). The docs server was confirmed running and serving HTTP 200 via curl.
References: §24063066748