Skip to content

[plan] Consolidate four API key Note callouts in Quick Start Step 2 into a tabbed engine-selector section #43687

Description

@github-actions

Objective

Consolidate the four sequential API key Note callouts in Quick Start Step 2 into a single tabbed/collapsed section so beginners only see the setup steps relevant to their chosen engine.

Context

Discussion #43686 (Documentation Noob Tester report) identified this as the top critical issue: four sequential collapsed Note blocks (COPILOT_GITHUB_TOKEN, ANTHROPIC_API_KEY, OPENAI_API_KEY, GEMINI_API_KEY) in Quick Start Step 2 create visual noise and anxiety — a beginner reading the docs doesn't know they only need one of these.

Screenshot: https://github.com/github/gh-aw/blob/assets/Documentation-Noob-Tester/d8e1dd2f36a7925052ac53cfe1c21f9b83810372015de9563d612c8acc51fa91.png?raw=true

File to Modify

docs/src/content/docs/setup/quick-start.mdx

Implementation Plan

Approach

  1. Locate Step 2 in quick-start.mdx where the four API key notes currently appear.
  2. Replace the four separate Note blocks with a single tabbed component (e.g., Starlight's <Tabs>/<TabItem> components, or an equivalent collapsible structure already used in the docs).
  3. Tabs should be labeled: Copilot, Claude (Anthropic), OpenAI, Gemini — each tab shows only that engine's token/key setup instructions.
  4. Add a brief lead-in sentence before the tabs: "Choose the AI engine you set up earlier and follow the corresponding instructions."

Files to Modify

  • docs/src/content/docs/setup/quick-start.mdx — replace the four sequential Note callouts with a tabbed section

Acceptance Criteria

  • The four API key setup blocks are replaced by a single tabbed component with one tab per engine
  • Each tab contains the same content as the original Note for that engine
  • A beginner only needs to read one tab, not four sequential blocks
  • The page renders correctly in the docs site (no broken MDX)

Generated by 📋 Plan Command · 27.1 AIC · ⌖ 10.7 AIC · ⊞ 4.9K · ◷
Comment /plan to run again

  • expires on Jul 7, 2026, 9:34 PM UTC-08:00

Metadata

Metadata

Labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions