Skip to content

[Code Quality] Add Secret Setup Guide with Screenshots to Documentation #13110

@github-actions

Description

@github-actions

Description

The Quick Start documentation mentions "set up required secrets" but doesn't explain WHAT secrets are needed, WHERE to add them, HOW to add them, or WHEN they're required. This blocks 90% of new users from successfully running their first workflow.

Current Problem

From /setup/quick-start/ Step 2:

  • Mentions secrets but no details on which ones
  • No GitHub UI navigation instructions
  • No distinction between Copilot/Claude/Codex requirements
  • Users don't know if secrets are optional or required

Beginner confusion: "I ran gh aw add and it asked for secrets. Do I need Copilot? Can I use Claude? How do I add a Claude API key?"

Suggested Solution

Add dedicated "Secret Setup" subsection with:

  1. Clear table showing all three engines and their requirements:

    • Copilot: Requires GitHub Copilot subscription (no additional secrets)
    • Claude: Requires ANTHROPIC_API_KEY secret
    • Codex: Requires OPENAI_API_KEY secret
  2. Step-by-step GitHub UI navigation with screenshots:

    • Repository → Settings → Secrets and variables → Actions
    • Click "New repository secret"
    • Name: ANTHROPIC_API_KEY
    • Value: sk-ant-...
    • Screenshot showing each step
  3. When secrets are required:

    • Only if using Claude or Codex engines
    • Not needed for Copilot (uses GitHub subscription)
    • Can add multiple secrets for multiple engines

Files Affected

  • docs/src/content/docs/setup/quick-start.md - Add new "Secret Setup" section
  • New screenshots needed (3-4 images)

Success Criteria

  • New "Secret Setup" section added before Step 2
  • Table showing all three engines and requirements
  • GitHub UI navigation with screenshots
  • Clear distinction between required vs optional
  • Link to detailed secrets documentation
  • Testing confirms new users can complete setup

Impact

Severity: Critical
Blocks: 90% of new users from successful first run
Benefit: Dramatically improved onboarding success rate, reduced support burden

Source

Extracted from Documentation Noob Test Report #13052 - Issue #1 (Highest Priority)

Priority

Critical - This is the #1 barrier to new user success

Estimated Effort

Medium (2 hours) - Includes creating screenshots and testing with new users

AI generated by Discussion Task Miner - Code Quality Improvement Agent

  • expires on Feb 15, 2026, 1:20 PM UTC

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions