Skip to content

[plan] Document engine selection in Quick Start interactive flow #12035

@github-actions

Description

@github-actions

Context

As identified in discussion #12027, the Quick Start guide mentions that gh aw init takes users through an "interactive process" but doesn't explicitly clarify that users will be prompted to select their AI engine (Claude, Copilot, or Codex).

Current State

docs/src/content/docs/setup/quick-start.md:54-55 states:

"This will take you through an interactive process to 1. Select an AI Engine to use 2. Add the workflow..."

While this technically mentions engine selection, it's not explicit enough about what engines are available and that Claude is a first-class option.

Problem

  • Users approaching the Quick Start may not realize Claude is available
  • The phrase "Select an AI Engine" is vague - what are the options?
  • Claude Code users may assume Copilot is required before reading further
  • Missing opportunity to reassure non-Copilot users early in the onboarding

Objective

Make the engine selection more explicit and welcoming to all engine users, particularly in the Quick Start guide.

Proposed Solution

Update docs/src/content/docs/setup/quick-start.md:54-55:

Current:

This will take you through an interactive process to 1. Select an AI Engine to use 2. Add the workflow...

Proposed:

This will take you through an interactive process to:
1. **Select an AI Engine** - You'll be prompted to choose between Claude, Copilot, or Codex
2. **Add the workflow** - Configure your first agentic workflow

Also consider adding to the Prerequisites section:

**AI Account** - You need one of the following:
   - Anthropic Claude API key (recommended for simple setup)
   - GitHub Copilot subscription
   - OpenAI API key for Codex

Files to Modify

  • docs/src/content/docs/setup/quick-start.md (around lines 21 for prerequisites, 54-55 for interactive flow)

Acceptance Criteria

  • Update interactive process description to explicitly list engine options
  • Add or update Prerequisites to show all three engine options
  • Use neutral language that doesn't suggest Copilot is primary
  • Verify documentation renders correctly
  • Consider adding a note about API key setup timing

Optional Enhancement

Consider adding a callout after the gh aw init command:

> [!TIP]
> Don't have a Copilot subscription? No problem! Claude and Codex work just as well for most workflows. Just select your preferred engine when prompted.

References

AI generated by Plan Command for discussion #12027

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions