Clarify Quick Start workflow source and engine secret setup#43107
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the Quick Start documentation to make the sample workflow reference format explicit and to provide consistent repository secret setup guidance for OpenAI and Gemini engines, aligning with the existing Copilot and Anthropic callout pattern.
Changes:
- Clarifies that
add-wizardaccepts<owner>/<repo>/<workflow-name>references and explains whatgithubnext/agentics/daily-repo-statuspoints to. - Adds Step 2
[!NOTE]callouts describing how to setOPENAI_API_KEYandGEMINI_API_KEY, including links back to the Authentication reference.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/setup/quick-start.mdx | Clarifies the workflow source reference and adds missing OpenAI/Gemini secret setup notes consistent with existing callouts. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Low
|
✅ Design Decision Gate 🏗️ completed the design decision gate check. No ADR enforcement needed: PR does not have the 'implementation' label and has 0 new lines of code in business logic directories (threshold: 100). |
|
✅ PR Code Quality Reviewer completed the code quality review. |
|
🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅ |
|
✅ Test Quality Sentinel completed test quality analysis. No test files were added or modified in this PR. Test Quality Sentinel skipped. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧵 Reviewed using Impeccable skills by Impeccable Skills Reviewer · 33.3 AIC · ⌖ 6.01 AIC · ⊞ 4.8K
|
|
||
| > [!NOTE] | ||
| > **Setting up `GEMINI_API_KEY`?** | ||
| > 1. Create an API key in [Google AI Studio](https://aistudio.google.com/app/apikey). |
There was a problem hiding this comment.
The Google AI Studio URL here ((aistudio.google.com/redacted) differs from the canonical URL used in auth.mdx ((aistudio.google.com/redacted) Both may resolve, but using a consistent URL makes docs easier to maintain and audit. Consider aligning with the existing reference:
-1. Create an API key in [Google AI Studio]((aistudio.google.com/redacted)
+1. Create an API key in [Google AI Studio]((aistudio.google.com/redacted)@copilot please address this.
There was a problem hiding this comment.
Skills-Based Review 🧠
Applied /grill-with-docs — approving with one minor suggestion.
📋 Key Themes & Highlights
Key Themes
- Missing alias note: The new
OPENAI_API_KEYcallout doesn't mention thatCODEX_API_KEYis also accepted and takes precedence. Users with a pre-existingCODEX_API_KEYmight unnecessarily add a second secret. See inline comment on line 94.
Positive Highlights
- ✅ Explanation moved before the code example — significantly improves first-read comprehension
- ✅ All four supported engines (Copilot, Anthropic, OpenAI, Gemini) now have matching setup callouts
- ✅ Consistent callout structure and link style throughout
- ✅ Tight, focused change — no unnecessary doc churn
🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · 44.8 AIC · ⌖ 5.12 AIC · ⊞ 6.6K
Comment /matt to run again
| > [!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. |
There was a problem hiding this comment.
[/grill-with-docs] The callout heading says OPENAI_API_KEY but the wizard step 3 uses the name Codex for this engine. The auth reference also documents that CODEX_API_KEY is an accepted alias (and tried first by the runtime). Users with an existing CODEX_API_KEY do not need to set OPENAI_API_KEY. Without mentioning this, they may add a redundant secret.
💡 Suggested wording addition
Add a sentence at the end of step 2 or a note below the callout:
> **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.@copilot please address this.
There was a problem hiding this comment.
No blocking issues found. The changes are correct and well-structured.
### Review summary
Anchor links — Both #openai_api_key and #gemini_api_key resolve correctly to their ### OPENAI_API_KEY and `### `GEMINI_API_KEY headings in auth.mdx. ✅
Paragraph reordering — Moving the format explanation before the command example is a clear readability improvement; no information is lost, and the new decomposed phrasing (githubnext/agentics = repo, daily-repo-status = workflow) is more explicit than the old formulation. ✅
Callout format — Both new [!NOTE] blocks follow the exact same structure as the existing Copilot and Anthropic notes (bold title, 2-step list, gh secret set < /path/to/key.txt, auth reference link). ✅
Minor non-blocking observation: The OPENAI_API_KEY note doesn't mention that CODEX_API_KEY is also accepted and tried first by the runtime. This is only relevant to users who already have the key stored under the old name. The link to the auth reference covers it for anyone who needs the detail, so this doesn't warrant changes here.
Warning
Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
patchdiff.githubusercontent.com
To allow these domains, add them to the
network.allowedlist in your workflow frontmatter:
network:
allowed:
- defaults
- "patchdiff.githubusercontent.com"See Network Configuration for more information.
🔎 Code quality review by PR Code Quality Reviewer · 83.1 AIC · ⌖ 6.54 AIC · ⊞ 5.4K
Comment /review to run again
|
|
||
| > [!NOTE] | ||
| > **Setting up `GEMINI_API_KEY`?** | ||
| > 1. Create an API key in [Google AI Studio](https://aistudio.google.com/app/apikey). |
There was a problem hiding this comment.
Stale Google AI Studio URL: /app/apikey diverges from the canonical path used everywhere else in the project and may redirect unexpectedly.
💡 Suggested fix
The rest of the project (both occurrences in auth.mdx) uses:
(aistudio.google.com/redacted)
Change this line to:
> 1. Create an API key in [Google AI Studio]((aistudio.google.com/redacted)This keeps the quick-start guide consistent with the authentication reference page.
|
@copilot please run the
|
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Done. Addressed the two
Local |
|
🎉 This pull request is included in a new release. Release: |
Quick Start assumed readers already understood what
githubnext/agenticsrefers to and only called out secret setup for Copilot and Anthropic. This update makes the sample workflow source explicit and adds missing setup guidance for OpenAI and Gemini users.Clarify the sample workflow source
<owner>/<repo>/<workflow-name>explanation ahead of thegh aw add-wizardexamplegithubnext/agenticsis the public examples repository and thatdaily-repo-statusis a workflow published thereComplete secret setup guidance
[!NOTE]callouts forOPENAI_API_KEYandGEMINI_API_KEYCOPILOT_GITHUB_TOKENandANTHROPIC_API_KEYKeep the page consistent