Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 27, 2026

Quick Start guide referenced engine selection vaguely, obscuring that Claude, Copilot, and Codex are all first-class options. Users may assume Copilot is required.

Changes

Prerequisites section - Expanded AI Account requirement to explicit list:

  • GitHub Copilot subscription (with link)
  • Anthropic Claude API key (with link, noted as "recommended for simple setup")
  • OpenAI Codex API key (with link)

Interactive process description - Changed from:

1. Select an AI Engine to use

To:

1. **Select an AI Engine** - You'll be prompted to choose between Claude, Copilot, or Codex

Added TIP callout after interactive process:

Don't have a Copilot subscription? No problem! Claude and Codex work just as well for most workflows.

All language treats engines neutrally without suggesting Copilot primacy.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.13.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>[plan] Document engine selection in Quick Start interactive flow</issue_title>
<issue_description>## 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

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Document AI engine selection in Quick Start flow docs: Clarify engine selection in Quick Start guide Jan 28, 2026
Copilot AI requested a review from pelikhan January 28, 2026 00:05
@github-actions
Copy link
Contributor

🔍 PR Triage Results

Category: docs | Risk: low | Priority: 43/100

Scores Breakdown

  • Impact: 18/50 - Documentation - improves user experience
  • Urgency: 7/30 - Recent PR, CI unstable
  • Quality: 18/20 - CI passing, small focused change

📋 Recommended Action: auto_merge

This PR is an excellent auto-merge candidate:

  • ✅ Low-risk documentation change
  • ✅ Small, focused scope (16 lines changed, 1 file)
  • ✅ CI passing
  • ✅ Clear user benefit

This documentation improvement clarifies engine selection options in the Quick Start guide, making it clear that Claude, Copilot, and Codex are all first-class options.


Triaged by PR Triage Agent on 2026-01-28T00:34:49Z

AI generated by PR Triage Agent

@pelikhan pelikhan marked this pull request as ready for review January 28, 2026 01:36
@pelikhan pelikhan merged commit b747d52 into main Jan 28, 2026
@pelikhan pelikhan deleted the copilot/document-engine-selection-quick-start branch January 28, 2026 01:36
Mossaka added a commit that referenced this pull request Jan 28, 2026
* Initial plan

* Add build and test tasks to all smoke workflows

- Add 'make build' and 'make test' task to smoke-copilot.md
- Add 'make build' and 'make test' task to smoke-codex.md
- Add 'make test' task to smoke-claude.md (already has build test)
- Add 'make build' and 'make test' task to smoke-opencode.md
- Recompile all workflows to update .lock.yml files
- Minimal changes following update-agentic-workflow.md guidelines
- No UI changes

CI note: lint-go failure in run 21378132566 is unrelated (unused funcs in add_command.go and add_interactive.go)

* Add changeset [skip-ci]

* Merge main and regenerate workflows

* Regenerate workflows after merge with main

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Add changeset [skip-ci]

* chore: increase smoke workflow timeouts and remove make test

- Increase timeout from 5/10 minutes to 15 minutes for all smoke workflows
- Remove 'make test' from smoke test steps, keeping only 'make build'
- Affects: smoke-copilot, smoke-codex, smoke-claude, smoke-opencode
- All workflows already have 'go' runtime configured (no changes needed)

* Add runtimes: go to smoke-opencode workflow

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Add changeset [skip-ci]

* Recompile workflows after merging origin/main

Updates lock files for security-alert-burndown and security-guard workflows
to incorporate environment variable mirroring changes from main branch.

Changes:
- Add GH_AW_TOOL_BINS environment variable construction
- Pass additional runner environment variables (ANDROID_*, CARGO_HOME, etc.)
- Update PATH construction to use GH_AW_TOOL_BINS

Related to env-mirror feature from origin/main.

* Update artifact usage counts for security-guard workflow

* Add changeset [skip-ci]

* Fix shell escaping for environment variable expansion in AWF

Pre-wrap environment variable values in double quotes so they're
properly expanded inside AWF containers. This fixes the PATH priority
mechanism for tools from actions/setup-*.

Changes:
- env_mirror.go: Wrap mirrored env vars in double quotes
- engine_helpers.go: Wrap GH_AW_TOOL_BINS in double quotes
- Updated tests to expect the new format
- Regenerated all lock files

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Regenerate lock files after merge

* Add changeset [skip-ci]

* docs: Clarify engine selection in Quick Start guide (#12135)

* Use go env GOROOT instead of GOROOT env var for Go bin path

actions/setup-go doesn't export GOROOT as an environment variable
(only adds Go to PATH). This caused GH_AW_TOOL_BINS to not include
the Go bin path, resulting in older Go versions from hostedtoolcache
being used due to alphabetical find ordering.

Fix: Use `command -v go && $(go env GOROOT)/bin` to dynamically
determine GOROOT from the Go toolchain itself.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Add changeset [skip-ci]

* Merge main and regenerate agentic workflows

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Fix Go build cache permission error in AWF sandbox

Add $HOME/.cache mount to AWF container configuration for all engines
(Claude, Codex, Copilot). This allows Go's build cache and other tool
caches (npm, etc.) to be writable inside the sandbox container.

The directory is created with `mkdir -p "$HOME/.cache"` before AWF runs
to ensure the mount path exists on the host.

Also added /home/runner/.cache to the SRT sandbox's default AllowWrite
list for consistency.

Fixes permission denied errors when running `make build` inside the
agent container (e.g., smoke-codex workflow).

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Add changeset [skip-ci]

* Use --dangerously-bypass-approvals-and-sandbox for Codex engine

Replace --full-auto and --sandbox danger-full-access flags with the
single --dangerously-bypass-approvals-and-sandbox flag which combines
both behaviors. This simplifies the command and is the recommended
approach for externally sandboxed environments like AWF.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* Add changeset [skip-ci]

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Jiaxiao Zhou <duibao55328@gmail.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
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] Document engine selection in Quick Start interactive flow

2 participants