Skip to content

docs: surface Claude engine option in quick-start add flow#43590

Merged
pelikhan merged 3 commits into
mainfrom
copilot/update-quick-start-docs
Jul 5, 2026
Merged

docs: surface Claude engine option in quick-start add flow#43590
pelikhan merged 3 commits into
mainfrom
copilot/update-quick-start-docs

Conversation

Copilot AI commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Quick-start currently shows gh aw add-wizard without 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 when engine: is omitted.

  • Quick-start add command now shows explicit Claude variant

    • Added --engine claude alongside the existing gh aw add-wizard example in Step 2.
  • Default engine behavior is now explicit

    • Added an IMPORTANT callout clarifying:
      • omitted engine: in frontmatter defaults to Copilot
      • Claude usage requires either --engine claude during add or engine: claude in frontmatter
  • Updated snippet

    gh aw add-wizard githubnext/agentics/daily-repo-status
    gh aw add-wizard githubnext/agentics/daily-repo-status --engine claude
    
    ---
    engine: claude
    ---

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update quick-start documentation to include --engine claude docs: surface Claude engine option in quick-start add flow Jul 5, 2026
Copilot AI requested a review from pelikhan July 5, 2026 16:27
@pelikhan pelikhan marked this pull request as ready for review July 5, 2026 16:39
Copilot AI review requested due to automatic review settings July 5, 2026 16:39
@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅

@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Test Quality Sentinel completed test quality analysis.

No test files were added or modified in this PR. Test Quality Sentinel skipped.

@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

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).

@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

PR Code Quality Reviewer completed the code quality review.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 claude example alongside the existing add-wizard command.
  • Introduces an [!IMPORTANT] callout documenting that omitted engine: defaults to Copilot and how to opt into Claude (--engine claude or engine: claude in 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

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@github-actions github-actions Bot mentioned this pull request Jul 5, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧠 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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[/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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added inline comments distinguishing the default (interactive) and Claude (pre-selected) variants. Fixed in the latest commit.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. 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 claude pre-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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/src/content/docs/setup/quick-start.mdx
@gh-aw-bot

Copy link
Copy Markdown
Collaborator

@copilot please run the skill, address unresolved review comments, and rerun checks once the branch is up to date.

Generated by 👨‍🍳 PR Sous Chef · 6.18 AIC · ⌖ 6.22 AIC · ⊞ 3.7K ·
Comment /souschef to run again

…uracy

Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot AI requested a review from gh-aw-bot July 5, 2026 18:13
@pelikhan pelikhan merged commit da5346f into main Jul 5, 2026
@pelikhan pelikhan deleted the copilot/update-quick-start-docs branch July 5, 2026 18:24
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.82.3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[plan] docs: Surface --engine claude in quick-start and document silent Copilot default

4 participants