Skip to content

docs: consolidate Quick Start API key notes into tabbed engine selector #43695

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 2 commits into from
Jul 6, 2026
Merged

docs: consolidate Quick Start API key notes into tabbed engine selector #43695

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
678bd1b
Initial plan
Copilot Jul 6, 2026
e656430
Replace four API key Note callouts with tabbed engine-selector in qui…
Copilot Jul 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 28 additions & 26 deletions docs/src/content/docs/setup/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar:
---

import Video from '../../../components/Video.astro';
import { Tabs, TabItem } from '@astrojs/starlight/components';

## Adding an Automated Daily Status Workflow to Your Repo

Expand Down Expand Up @@ -84,32 +85,33 @@ This will take you through an interactive process to:
> [!NOTE]
> The `.lock.yml` is the compiled GitHub Actions workflow generated from your markdown — it is what actually runs, and it is regenerated automatically, so you never edit it by hand. See [Lock File](/gh-aw/reference/workflow-structure/#lock-file-header) for the full explanation.

> [!NOTE]
> **Setting up `COPILOT_GITHUB_TOKEN`?**
> 1. [Create a fine-grained Personal Access Token (PAT)](https://github.com/settings/personal-access-tokens/new) under your user account.
> 2. Under **Permissions → Account permissions**, set **Copilot Requests** to **Read**, then generate the token.
> 3. Add it as a repository secret from your repository root with `gh secret set COPILOT_GITHUB_TOKEN < /path/to/token.txt`, or use the GitHub UI. See [Authentication](/gh-aw/reference/auth/#copilot_github_token) for more detail.
>

> [!NOTE]
> **Setting up `ANTHROPIC_API_KEY`?**
> 1. Create an API key in [Anthropic Console](https://console.anthropic.com/settings/keys).
> 2. Add it as a repository secret from your repository root with `gh secret set ANTHROPIC_API_KEY < /path/to/key.txt`, or use the GitHub UI. See [Authentication](/gh-aw/reference/auth/#anthropic_api_key) for more detail.
>

> [!NOTE]
> **Setting up `OPENAI_API_KEY`?**
> 1. Create an API key in [OpenAI API keys](https://platform.openai.com/api-keys).
> 2. Add it as a repository secret from your repository root with `gh secret set OPENAI_API_KEY < /path/to/key.txt`, or use the GitHub UI. See [Authentication](/gh-aw/reference/auth/#openai_api_key) for more detail.
>
> **Tip:** `CODEX_API_KEY` is also accepted and takes precedence over `OPENAI_API_KEY` — if you have already stored the key under that name, no action is needed. See [Authentication](/gh-aw/reference/auth/#openai_api_key) for details.
>

> [!NOTE]
> **Setting up `GEMINI_API_KEY`?**
> 1. Create an API key in [Google AI Studio](https://aistudio.google.com/api-keys).
> 2. Add it as a repository secret from your repository root with `gh secret set GEMINI_API_KEY < /path/to/key.txt`, or use the GitHub UI. See [Authentication](/gh-aw/reference/auth/#gemini_api_key) for more detail.
>
**Setting up your API key?** Select the engine you chose above:

@github-actions github-actions Bot Jul 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[/grill-with-docs] The phrase "Select the engine you chose above" relies on page position — on a long page or when linked directly, users may not recall which engine they chose earlier.

💡 Suggested wording

Something like:

Setting up your API key? Select the engine you configured in the wizard (Step 2 above):

or simply drop the locator and make it self-contained:

Setting up your API key? Select your engine:

The second option removes the dependency on vertical page context entirely and is safe regardless of how the user arrived at this section.

@copilot please address this.


<Tabs>
Comment thread
pelikhan marked this conversation as resolved.
<TabItem label="Copilot">
**Setting up `COPILOT_GITHUB_TOKEN`:**
1. [Create a fine-grained Personal Access Token (PAT)](https://github.com/settings/personal-access-tokens/new) under your user account.
2. Under **Permissions → Account permissions**, set **Copilot Requests** to **Read**, then generate the token.
3. Add it as a repository secret from your repository root with `gh secret set COPILOT_GITHUB_TOKEN < /path/to/token.txt`, or use the GitHub UI. See [Authentication](/gh-aw/reference/auth/#copilot_github_token) for more detail.
</TabItem>
<TabItem label="Claude">
**Setting up `ANTHROPIC_API_KEY`:**
1. Create an API key in [Anthropic Console](https://console.anthropic.com/settings/keys).
2. Add it as a repository secret from your repository root with `gh secret set ANTHROPIC_API_KEY < /path/to/key.txt`, or use the GitHub UI. See [Authentication](/gh-aw/reference/auth/#anthropic_api_key) for more detail.
</TabItem>
Comment thread
pelikhan marked this conversation as resolved.
<TabItem label="Codex">
**Setting up `OPENAI_API_KEY`:**
1. Create an API key in [OpenAI API keys](https://platform.openai.com/api-keys).
2. Add it as a repository secret from your repository root with `gh secret set OPENAI_API_KEY < /path/to/key.txt`, or use the GitHub UI. See [Authentication](/gh-aw/reference/auth/#openai_api_key) for more detail.

**Tip:** `CODEX_API_KEY` is also accepted and takes precedence over `OPENAI_API_KEY` — if you have already stored the key under that name, no action is needed. See [Authentication](/gh-aw/reference/auth/#openai_api_key) for details.
</TabItem>
<TabItem label="Gemini">
**Setting up `GEMINI_API_KEY`:**
1. Create an API key in [Google AI Studio](https://aistudio.google.com/api-keys).
2. Add it as a repository secret from your repository root with `gh secret set GEMINI_API_KEY < /path/to/key.txt`, or use the GitHub UI. See [Authentication](/gh-aw/reference/auth/#gemini_api_key) for more detail.
</TabItem>
</Tabs>
Comment thread
pelikhan marked this conversation as resolved.

> [!TIP]
> **Having trouble?** Check your [repository secrets](/gh-aw/reference/auth/), see the [FAQ](/gh-aw/reference/faq/) and [Common Issues](/gh-aw/troubleshooting/common-issues/).
Expand Down
Loading