Skip to content

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

Description

@github-actions

Objective

Update docs/src/content/docs/setup/quick-start.mdx to show --engine claude in the primary workflow add example and explicitly state that omitting engine: defaults to Copilot.

Context

From documentation review discussion #43544 (Priority 2):

Silent Copilot default. Copilot is the default engine; 35 example workflows omit engine: entirely and resolve to Copilot. --engine claude exists (cli.md:142) but is not surfaced in the quick-start add flow.

A Claude user following the quick-start sees gh aw add without --engine claude and may not realize their workflow will run on Copilot by default.

Files to Modify

  • docs/src/content/docs/setup/quick-start.mdx
    • In the gh aw add example step, show --engine claude as a variant or alongside the Copilot example
    • Add a callout stating: omitting engine: defaults to Copilot; pass --engine claude (or set engine: claude in frontmatter) to use Claude

Acceptance Criteria

  • The quick-start gh aw add section shows --engine claude as an explicit option
  • A note explains the default engine is Copilot when engine: is omitted
  • Claude users can follow the quick-start without accidentally defaulting to Copilot

Generated by 📋 Plan Command · 20.9 AIC · ⌖ 6.74 AIC · ⊞ 4.9K ·
Comment /plan to run again

  • expires on Jul 7, 2026, 7:22 AM UTC-08:00

Metadata

Metadata

Labels

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions