Repository navigation
[claude-code-user-docs-review] 🔍 Claude Code User Documentation Review - 2026-08-17 #53379
Closed
Replies: 1 comment
|
This discussion has been marked as outdated by Claude Code User Documentation Review. A newer discussion is available at Discussion #53691. |
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Executive Summary
A Claude Code user can onboard to gh-aw without ever touching GitHub Copilot —
ANTHROPIC_API_KEYsetup and--engine claudeare documented — but the docs consistently treat Copilot as the "real" default and Claude as the exception path. The sharpest gap: Claude Code users are explicitly told their existing subscription auth (CLAUDE_CODE_OAUTH_TOKENfromclaude login) is not supported, forcing a separate pay-per-token setup many won't expect.Severity Findings (click to expand)
Critical Blockers
CLAUDE_CODE_OAUTH_TOKEN, including a token fromclaude login, "is not supported and is ignored if set" — a Claude Code user's existing daily-driver auth cannot be reused; they must provisionANTHROPIC_API_KEYor Anthropic WIF instead. (README.md:41,docs/src/content/docs/setup/quick-start.mdx:148-150,docs/src/content/docs/setup/cli.md:259)engine:field is removed from frontmatter, "the runtime defaults to Copilot" — a Claude user copying/trimming a workflow can silently end up needing Copilot secrets instead of Anthropic ones, with no warning at compile time. (docs/src/content/docs/setup/quick-start.mdx:116)Major Obstacles
gh aw initonly describes what Claude users don't get. The Copilot path gets a custom agent file + default MCP integration;--engine claudeis documented only as "Skip Copilot-specific artifacts," with no description of any Claude-equivalent scaffolding. (docs/src/content/docs/setup/cli.md:151-158).github/workflows/*.md,engine: copilotappears in 133 workflows vs. 60 forengine: claude(Codex: 15, custom: 0) — Claude users have roughly half as many worked examples to learn patterns from.web-search:support for Claude is unstated. Docs say "some engines require third-party MCP servers for web search" without naming which ones — a Claude user can't tell if it works natively or needs extra setup. (docs/src/content/docs/reference/tools.md:62-65,67)docs/src/content/docs/introduction/architecture.mdx:197)Minor Confusion
docs/src/content/docs/setup/quick-start.mdx:71)cli-proxy:classification inconsistency. Documented as a generic/engine-agnostic tool in the tools reference, but called out as a hard requirement specifically for Pi elsewhere — unclear if any Claude workflow ever needs it. (docs/src/content/docs/reference/tools.md:129-149vs.docs/src/content/docs/setup/quick-start.mdx:169)copilot-requestsactionlint carve-out has no Claude counterpart mentioned, leaving it unclear whether Claude-specific permission scopes need similar linter handling. (docs/src/content/docs/setup/cli.md:394)Engine & Tool Matrix
how-they-work.mdx:26)copilot-requestsperm orCOPILOT_GITHUB_TOKENPAT, richly documented (cli.md:180)quick-start.mdx:144-146), but subscription token blockedANTHROPIC_API_KEY/WIF only;CLAUDE_CODE_OAUTH_TOKENunsupportedCODEX_API_KEYorOPENAI_API_KEYquick-start.mdx:153-157)Tool classification (from
reference/tools.md): 15 engine-agnostic, 3 Copilot-specific, 1 Claude-specific, 1 Codex-specific, 1 Pi-specific, 1 ambiguous (web-search:). Tool-operation timeout defaults are stated only for Claude (60s) and Codex (120s) — Copilot/Gemini/Pi defaults are unstated in the same table (tools.md:157).Auth Gaps
ANTHROPIC_API_KEYor Anthropic WIF — clearly documented, but the explicit rejection ofclaude loginOAuth tokens is the single biggest surprise for this persona. (quick-start.mdx:148-150)cli.md:180)CODEX_API_KEYtakes precedence overOPENAI_API_KEYif both set — documented, no gaps found.model:prefix") with no inline setup steps, deferring entirely to an external guide — weakest auth documentation of the five engines. (quick-start.mdx:166-169)GITHUB_TOKENcannot create GitHub Projects (needs a separate PAT), and MCP gateway API keys mounted into agent containers are explicitly not a strong security boundary against a compromised agent — both apply to all engines but are easy to miss. (cli.md:944-949,architecture.mdx:291)Recommended Actions
Priority 1
ANTHROPIC_API_KEYsetup step clarifying whyclaude logintokens don't work and what the cost/setup implications are, so Claude Code users aren't surprised mid-setup.engine:behavior a compile-time warning, or at least surface it more prominently than a single note in quick-start.Priority 2
3. Document what
gh aw init --engine claudedoes produce, not just what it skips (cli.md:151-158).4. Clarify per-engine
web-search:support explicitly (which engines need an MCP server, which don't) (tools.md:62-67).5. Add a Claude-equivalent (or engine-agnostic) self-hosted runner / ARC-DinD guide reference (
architecture.mdx:197).Priority 3
6. Add at least one dogfooded
engine: customexample workflow.7. Rebalance example-workflow coverage so Claude/Codex aren't ~2-9x thinner than Copilot's.
8. Reframe the prerequisites section to present engine choice neutrally rather than Copilot-first.
References:
All reactions