docs: surface Claude engine option in quick-start add flow#43590
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
|
🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅ |
|
✅ Test Quality Sentinel completed test quality analysis. No test files were added or modified in this PR. Test Quality Sentinel skipped. |
|
✅ Design Decision Gate 🏗️ completed the design decision gate check. No ADR enforcement needed: PR #43590 does not have the 'implementation' label and has 0 new lines of code in business logic directories (threshold: 100). |
|
✅ PR Code Quality Reviewer completed the code quality review. |
There was a problem hiding this comment.
Pull request overview
Updates the quick-start documentation to make the Claude engine path explicit at the workflow add step, and to clarify the default engine behavior when engine: is omitted from workflow frontmatter.
Changes:
- Adds an explicit
gh aw add-wizard ... --engine claudeexample alongside the existing add-wizard command. - Introduces an
[!IMPORTANT]callout documenting that omittedengine:defaults to Copilot and how to opt into Claude (--engine claudeorengine: claudein frontmatter).
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/setup/quick-start.mdx | Adds a Claude add-wizard example and a callout clarifying Copilot default engine behavior when engine: is omitted. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Low
There was a problem hiding this comment.
Review: docs: surface Claude engine option in quick-start add flow
Clean, focused documentation improvement. The changes are accurate and useful.
What looks good:
- The prose lead-in (one
🧵 Reviewed using Impeccable skills by Impeccable Skills Reviewer · 14.2 AIC · ⌖ 5.97 AIC · ⊞ 4.9K
There was a problem hiding this comment.
🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · 27.1 AIC · ⌖ 6.54 AIC · ⊞ 6.7K
Comment /matt to run again
|
|
||
| ```text wrap | ||
| gh aw add-wizard githubnext/agentics/daily-repo-status | ||
| gh aw add-wizard githubnext/agentics/daily-repo-status --engine claude |
There was a problem hiding this comment.
[/grill-with-docs] Two commands in one code block without a clear "choose one" label — a new user may try to run both sequentially, or not know which applies.
💡 Suggested fix
Split into two labelled blocks, or add inline comments to distinguish:
gh aw add-wizard githubnext/agentics/daily-repo-status # Copilot (default)
gh aw add-wizard githubnext/agentics/daily-repo-status --engine claude # Claude
Or separate them:
For Copilot (default):
gh aw add-wizard githubnext/agentics/daily-repo-status
For Claude:
gh aw add-wizard githubnext/agentics/daily-repo-status --engine claude
@copilot please address this.
There was a problem hiding this comment.
Added inline comments distinguishing the default (interactive) and Claude (pre-selected) variants. Fixed in the latest commit.
There was a problem hiding this comment.
REQUEST_CHANGES — One accuracy issue and one readability issue in the added documentation.
Findings summary
Accuracy: IMPORTANT callout contradicts the wizard's interactive Step 2
The callout claims add-wizard without --engine defaults to Copilot, but the unchanged text immediately below shows Step 2 is an interactive Select an AI Engine prompt. The callout conflates the runtime frontmatter default (engine omitted from installed file) with the add-time wizard behaviour (engine flag omitted from CLI invocation). This is factually misleading and will confuse users.
See inline comment on line 68 for a concrete fix.
Readability: undifferentiated two-command block
The code block shows two commands with no inline labels — readers must already know why there are two, or scroll past to the IMPORTANT note. Adding a # comment per command or restructuring the prose makes the block self-explanatory.
See inline comment on line 62.
🔎 Code quality review by PR Code Quality Reviewer · 54.5 AIC · ⌖ 5.4 AIC · ⊞ 5.4K
Comment /review to run again
| gh aw add-wizard githubnext/agentics/daily-repo-status --engine claude | ||
| ``` | ||
|
|
||
| > [!IMPORTANT] |
There was a problem hiding this comment.
Contradicts the wizard's own interactive step: the callout says omitting engine: "defaults to Copilot", but Step 2 of the wizard (unchanged text immediately below) is an explicit Select an AI Engine prompt — the wizard doesn't silently default.
💡 What to fix
The unchanged doc already states:
- Select an AI Engine — Choose between Copilot, Claude, Codex, or Gemini.
So add-wizard without --engine prompts interactively; it does not silently route to Copilot. The IMPORTANT callout conflates two distinct behaviours:
- Add-time shortcut:
--engine claudepre-answers the interactive prompt and skips Step 2. - Runtime default: if
engine:is later deleted from the installed frontmatter manually, the compiled workflow defaults to Copilot.
Blurring these will make users think the wizard silently routes them to Copilot when they skip the flag. Suggested rewrite:
> [!IMPORTANT]
> Passing `--engine claude` pre-selects Claude and skips the interactive engine prompt (Step 2 below).
> If you omit the flag, the wizard will ask you to choose.
> Note: if `engine:` is later removed from the workflow frontmatter manually, the runtime defaults to Copilot.If the wizard's prompt actually defaults to Copilot as a pre-selected choice, state that explicitly so the callout is accurate and consistent with the step list below.
There was a problem hiding this comment.
Rewrote the callout to accurately describe what --engine claude does: pre-selects Claude and skips the interactive engine prompt. The note about the runtime defaulting to Copilot is now scoped to the "frontmatter removed manually" case. Fixed in the latest commit.
|
@copilot please run the skill, address unresolved review comments, and rerun checks once the branch is up to date.
|
…uracy Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
|
🎉 This pull request is included in a new release. Release: |
Quick-start currently shows
gh aw add-wizardwithout making the engine default explicit, which can silently route Claude users to Copilot. This update makes the Claude path visible at the add step and documents Copilot as the default whenengine:is omitted.Quick-start add command now shows explicit Claude variant
--engine claudealongside the existinggh aw add-wizardexample in Step 2.Default engine behavior is now explicit
IMPORTANTcallout clarifying:engine:in frontmatter defaults to Copilot--engine claudeduring add orengine: claudein frontmatterUpdated snippet