Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-07-21#46934

Merged
pelikhan merged 1 commit into
mainfrom
doc-healer/quick-start-oauth-note-2026-07-21-9480b64e50fb3181
Jul 21, 2026
Merged

[docs] Self-healing documentation fixes from issue analysis - 2026-07-21#46934
pelikhan merged 1 commit into
mainfrom
doc-healer/quick-start-oauth-note-2026-07-21-9480b64e50fb3181

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a clarifying note to the quick-start guide's Claude tab informing users that CLAUDE_CODE_OAUTH_TOKEN (Claude subscription OAuth tokens) are not supported and will be ignored if set. Directs users to use ANTHROPIC_API_KEY instead, with a link to the auth reference for keyless alternatives.

Changes

File Change
docs/src/content/docs/setup/quick-start.mdx Added :::note block under the Anthropic API key setup section

Details

  • Type: Documentation fix
  • Breaking: No
  • Scope: docs/setup/quick-start.mdx — Anthropic (Claude) tab only

This addresses user confusion where setting CLAUDE_CODE_OAUTH_TOKEN (used by Claude Code CLI) has no effect in gh-aw, which requires ANTHROPIC_API_KEY.

Generated by PR Description Updater for #46934 · 19.4 AIC · ⌖ 4.38 AIC · ⊞ 4.8K ·

…ude tab

Closes #46613

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor Author

Thanks for the documentation improvement — this is a valid fix addressing issue #46613. However, this PR violates the project's contribution process.

Contribution Process Violation

Per CONTRIBUTING.md:

🚫 Traditional Pull Requests Are Not Enabled for non-Core team members: If you are not part of the core team, please do not create pull requests directly. Instead, you create detailed agentic plans in issues, discuss with the team, and a core team member will create and implement the PR for you using agents.

This PR was automatically created by the Daily Documentation Healer workflow. Automated workflows should not bypass the contribution process — documentation gaps should be surfaced as issues or agentic plans, then a core team member implements the fix using their agent.

Next Steps

Please:

  1. Close this PR — it was created outside the approved workflow.
  2. Open an issue or discussion describing the documentation gap and root cause analysis (the detailed breakdown in this PR is excellent — that belongs in an issue).
  3. A core team member will then implement the fix using their coding agent following the standard process.

Generated by ✅ Contribution Check · 69 AIC · ⌖ 16.1 AIC · ⊞ 6.2K ·

@pelikhan
pelikhan marked this pull request as ready for review July 21, 2026 03:31
Copilot AI review requested due to automatic review settings July 21, 2026 03:31
@pelikhan
pelikhan merged commit 3ce8ac7 into main Jul 21, 2026
5 checks passed
@pelikhan
pelikhan deleted the doc-healer/quick-start-oauth-note-2026-07-21-9480b64e50fb3181 branch July 21, 2026 03:31
@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Test Quality Sentinel completed test quality analysis.

No test files were added or modified in this PR. Test Quality Sentinel skipped. PR #46934 is a documentation-only change (docs/src/content/docs/setup/quick-start.mdx).

@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Design Decision Gate 🏗️ completed the design decision gate check.

No ADR enforcement needed: PR #46934 does not have the 'implementation' label and has 0 new lines of code in business logic directories (threshold: 100).

@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅

@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

PR Code Quality Reviewer completed the code quality review.

Copilot AI left a comment

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.

Pull request overview

Adds Claude OAuth limitations to the quick-start authentication guidance.

Changes:

  • Clarifies that CLAUDE_CODE_OAUTH_TOKEN is unsupported and ignored.
  • Directs users to ANTHROPIC_API_KEY and keyless authentication guidance.
Show a summary per file
File Description
docs/src/content/docs/setup/quick-start.mdx Adds a Claude authentication note.

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: 1
  • Review effort level: Medium

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
Claude subscription OAuth tokens (`CLAUDE_CODE_OAUTH_TOKEN`) are not supported and are ignored if set. Use an `ANTHROPIC_API_KEY` instead. See [Authentication](/gh-aw/reference/auth/#anthropic_api_key) for keyless alternatives.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Documentation-only change (4 lines). The note is factually accurate — consistent with auth.mdx line 208 which already documents that CLAUDE_CODE_OAUTH_TOKEN is unsupported and ignored. No logic, no code paths affected. No blocking issues found.

🔎 Code quality review by PR Code Quality Reviewer · 13.9 AIC · ⌖ 4.31 AIC · ⊞ 5.6K
Comment /review to run again

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Documentation note is accurate, well-placed, and uses correct Starlight :::note syntax. No issues found.

🧵 Reviewed using Impeccable skills by Impeccable Skills Reviewer · 13.5 AIC · ⌖ 4.93 AIC · ⊞ 5K

@github-actions github-actions Bot mentioned this pull request Jul 21, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Skills-Based Review 🧠

Applied /grill-with-docs — one actionable issue found.

📋 Summary

Issue

The added :::note closes a real documentation gap (Issue #46613) — the content and placement are correct. However, the link text "See Authentication for keyless alternatives" points to the wrong anchor. The #anthropic_api_key section covers API key setup, not keyless/WIF authentication; that content is under #anthropic-workload-identity-federation-wif.

Positive Highlights

  • ✅ Correct Starlight :::note syntax in the right tab
  • ✅ Verified claim — matches existing documentation in reference/auth.mdx line 208
  • ✅ Good cross-referencing strategy; one anchor fix makes it complete

🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · 24.4 AIC · ⌖ 4.49 AIC · ⊞ 6.7K
Comment /matt to run again

:::note
Claude subscription OAuth tokens (`CLAUDE_CODE_OAUTH_TOKEN`) are not supported and are ignored if set. Use an `ANTHROPIC_API_KEY` instead. See [Authentication](/gh-aw/reference/auth/#anthropic_api_key) for keyless alternatives.
:::
</TabItem>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

[/grill-with-docs] The link anchor #anthropic_api_key does not lead to keyless/WIF documentation — that lives at #anthropic-workload-identity-federation-wif. Users who follow the link looking for keyless options will land in the wrong section.

💡 Suggested fix
:::note
Claude subscription OAuth tokens (`CLAUDE_CODE_OAUTH_TOKEN`) are not supported and are ignored if set. Use an `ANTHROPIC_API_KEY` instead. For keyless alternatives, see [Anthropic WIF](/gh-aw/reference/auth/#anthropic-workload-identity-federation-wif).
:::

This matches the exact wording and anchor used in reference/auth.mdx line 208.

@copilot please address this.

@github-actions

Copy link
Copy Markdown
Contributor Author

🎉 This pull request is included in a new release.

Release: v0.82.15

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants