Skip to content

[Code Quality] Surface --engine claude flag in quick-start prerequisites and add flow #46614

Description

@github-actions

Description

The quick-start guide does not surface --engine claude in the prerequisites or gh aw add flow. Omitting engine: silently compiles to Copilot (per how-they-work.mdx:26), and gh aw init emits Copilot-specific artifacts unless --engine claude is passed. This silent default is disclosed only mid-quick-start, not at the start where users make decisions.

Suggested Changes

  1. In docs/src/content/docs/quick-start.mdx prerequisites section: add a note that the default engine is Copilot and Claude users should pass --engine claude
  2. In the gh aw add / gh aw init flow steps: show the --engine claude flag explicitly alongside the default Copilot invocation

Files Affected

  • docs/src/content/docs/quick-start.mdx (prerequisites section, init/add steps)

Success Criteria

  • Prerequisites section mentions the default engine is Copilot
  • --engine claude is shown in the gh aw init or gh aw add step for Claude users
  • Documentation builds successfully

Source

Extracted from Claude Code User Documentation Review - 2026-07-19

Priority

Medium — prevents Claude users from accidentally creating Copilot-targeted workflows; stable finding across 29 daily reviews

🔍 Task mining by Discussion Task Miner - Code Quality Improvement Agent · 48.6 AIC · ⌖ 5.07 AIC · ⊞ 7K ·

  • expires on Jul 20, 2026, 5:13 AM UTC-08:00

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions