docs: close non-Copilot engine parity gaps for gh aw init and custom engine frontmatter - #53834
Merged
Merged
Conversation
…form Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Document non-Copilot init/example parity gaps for engines
docs: close non-Copilot engine parity gaps for Aug 18, 2026
gh aw init and custom engine frontmatter
Contributor
PR Triage
Small doc parity fix (23 lines), draft, no urgency. Merge when convenient.
|
pelikhan
approved these changes
Aug 19, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies engine portability and non-Copilot initialization behavior across the documentation.
Changes:
- Documents artifacts created or skipped for non-Copilot engines.
- Clarifies custom engine configuration.
- Adds guidance for adapting examples between engines.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/setup/cli.md |
Documents non-Copilot initialization behavior. |
docs/src/content/docs/reference/engines.md |
Clarifies custom engine selection. |
docs/src/content/docs/examples/index.md |
Adds engine portability guidance. |
Review details
Suppressed comments (1)
docs/src/content/docs/setup/cli.md:180
- Changing only
engine:and authentication is not sufficient for every example. The engine reference explicitly notes that switching may also require different tools, model names, or network access, beyond theengine.agentandengine.harnesscases. The categorical adaptation claim should direct users to review all engine-specific settings.
The engine chosen at `init` time does not restrict workflows: every workflow selects its own engine in frontmatter, and example workflows written for one engine can be adapted to another by changing `engine:` and its authentication secret.
- Files reviewed: 3/3 changed files
- Comments generated: 3
- Review effort level: Balanced
| Do not treat imported definitions as supported unless their engine owner explicitly supports them. The OpenCode, Aider, Crush, Cursor, and Kiro files listed above remain samples; copy or adapt them only under the maintenance and support terms provided by their respective owners. | ||
|
|
||
| > [!NOTE] | ||
| > There is no flat `engine: custom` value. `engine:` in string form only accepts a built-in engine ID (`copilot`, `claude`, `codex`, `gemini`, `pi`); any other value fails compilation. Third-party and self-defined engines always use the nested object form with `engine.id` set to the ID declared by an imported engine definition, as shown above. |
| | Custom agent `.github/agents/agentic-workflows.md` | ✅ | ❌ | Use the dispatcher skill, or author an agent file in your own agent's format (Claude Code subagents, Codex prompts) from the same instructions | | ||
| | MCP wiring: `.github/mcp.json` and `.github/workflows/copilot-setup-steps.yml` | ✅ | ❌ | Register `gh aw mcp-server` in your own MCP host configuration — see [GH-AW as an MCP Server](/gh-aw/reference/gh-aw-as-mcp-server/) | | ||
|
|
||
| After `init`, the remaining steps are the same for every engine: pick the engine in workflow frontmatter (`engine: claude`, `engine: codex`, `engine: gemini`, `engine: pi`) and configure that engine's authentication secret. See [AI Engines](/gh-aw/reference/engines/) and [Authentication](/gh-aw/reference/auth/). |
|
|
||
| ## Examples and AI engines | ||
|
|
||
| Most examples specify the default Copilot engine or omit `engine:` entirely, so the published example set is not evenly distributed across engines. Examples are engine-portable: to run one on Claude, Codex, Gemini, or Pi, change `engine:` in the workflow frontmatter and configure that engine's authentication secret. Engine-specific options such as `engine.agent` or `engine.harness` are not portable — see the [engine feature comparison](/gh-aw/reference/engines/#engine-feature-comparison) before switching. |
Contributor
|
🎉 This pull request is included in a new release. Release: |
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.
cli.mdtold non-Copilot users thatgh aw init"skips these Copilot-specific artifacts" without saying what they get instead, and the reported flatengine: customform does not exist anywhere in the docs or examples. Documentation-only fix.setup/cli.md— new "Initializing for non-Copilot engines" subsection.gitattributesand the dispatcher skill (.github/skills/agentic-workflows/SKILL.md) are created for every engine; only.github/agents/agentic-workflows.mdand the MCP wiring (.github/mcp.json+copilot-setup-steps.yml) are Copilot-gated.gh aw mcp-servermanually via GH-AW as an MCP Server.engine:+ that engine's auth secret) and that theinit-time engine does not constrain per-workflow engine choice.reference/engines.md— custom engine formNote clarifying that string-form
engine:accepts only built-in IDs; third-party engines always use nestedengine.id+ an imported definition. Verified against the compiler:examples/index.md— engine portabilityExplains the Copilot-skewed example distribution and that examples port across engines by changing
engine:and its auth secret, flaggingengine.agent/engine.harnessas non-portable with a pointer to the feature comparison table.