Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 3 commits into from
Jul 5, 2026
+10 −1
Merged

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a279c9e
Initial plan
Copilot Jul 5, 2026
7956c54
docs: clarify Claude engine option in quick-start add step
Copilot Jul 5, 2026
b166506
docs: add inline comments to code block and fix IMPORTANT callout acc…
Copilot Jul 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/src/content/docs/setup/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,21 @@ gh extension install github/gh-aw

`add-wizard` accepts workflow references in `<owner>/<repo>/<workflow-name>` format. In this guide, `githubnext/agentics` is the public [githubnext/agentics](https://github.com/githubnext/agentics) examples repository, and `daily-repo-status` is one of the sample workflows it publishes.

From your repository root run:
From your repository root, run one of these commands:

Comment thread
pelikhan marked this conversation as resolved.
```text wrap
# default — wizard will ask you to choose an engine interactively
gh aw add-wizard githubnext/agentics/daily-repo-status

# pre-select Claude and skip the interactive engine prompt
gh aw add-wizard githubnext/agentics/daily-repo-status --engine claude

@github-actions github-actions Bot Jul 5, 2026

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.

Copilot AI Jul 5, 2026

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.

```

> [!IMPORTANT]

@github-actions github-actions Bot Jul 5, 2026

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.

Copilot AI Jul 5, 2026

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.

> Passing `--engine claude` pre-selects Claude and skips the interactive engine-selection step (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.

This will take you through an interactive process to:

1. **Check prerequisites** - Verify repository permissions.
Expand Down