Clarify gh aw init docs for Copilot-only agent/MCP artifacts - #52581
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
gh aw init docs for Copilot-only agent/MCP artifacts
|
Great work on clarifying the documentation! 🎯 This PR addresses the CLI consistency issue (#52504) by correcting the documentation for Why this is solid:
The documentation improvements ensure that users won't be confused about which features are engine-specific. Ready for review!
|
PR TriageCategory: docs · Risk: low · Priority: low · Score: 23/100
Recommended action: Clarifies that
|
There was a problem hiding this comment.
Pull request overview
Clarifies that gh aw init creates agent and MCP artifacts only for the Copilot engine.
Changes:
- Documents engine-gated initialization behavior.
- Updates Copilot-specific flag examples.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/setup/cli.md |
Clarifies Copilot-only initialization artifacts and flags. |
Review details
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Suppressed comments (1)
docs/src/content/docs/setup/cli.md:158
- This command does not select the Copilot engine, so no custom agent would be created even without
--no-agent; the example therefore does not demonstrate the flag's behavior. Add--engine copilotto match the engine-gated behavior documented above.
gh aw init --no-agent # Skip custom agent creation (Copilot engine)
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Balanced
| gh aw init # Initialize repository with defaults (non-interactive) | ||
| gh aw init --engine claude # Skip Copilot-specific artifacts | ||
| gh aw init --no-mcp # Skip MCP server integration | ||
| gh aw init --no-mcp # Skip MCP server integration (Copilot engine) |
The CLI docs for
gh aw initimplied MCP/custom-agent artifacts are created unconditionally. Actual behavior is engine-gated: these artifacts are created only when using the Copilot engine.What changed
initsection indocs/src/content/docs/setup/cli.mdto state:.gitattributes+ dispatcher skill setup.--engine copilot) includes:.github/agents/agentic-workflows.md--no-mcp)Docs wording alignment
--no-mcpand--no-agentexample comments to explicitly indicate Copilot-engine scope.Illustrative snippet