[claude-code-user-docs-review] 🔍 Claude Code User Documentation Review - 2026-07-05 #43544
Closed
Replies: 2 comments 1 reply
-
|
/plan |
Beta Was this translation helpful? Give feedback.
1 reply
-
|
This discussion has been marked as outdated by Claude Code User Documentation Review. A newer discussion is available at Discussion #43790. |
Beta Was this translation helpful? Give feedback.
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 gh-aw without touching Copilot —
engine: claude+ANTHROPIC_API_KEYis a first-class path documented in the quick-start. 0 critical blockers (19 daily runs running). The single most persona-relevant gap: Claude's auth story only documents a pay-per-use consoleANTHROPIC_API_KEY, with no PAT-free/subscription-OAuth shortcut equivalent to Copilot's org-billing path — so a Claude Pro/Max subscriber has to create a separate console key. Overall score 7.5/10 (stable).Severity Findings
Critical → Major → Minor (click to expand)
Critical blockers: none. Every built-in tool is engine-agnostic; no feature is Copilot-gated.
Major obstacles
copilot-requests:write(no PAT) and aCOPILOT_GITHUB_TOKENPAT (cli.md:171). Claude documents only a consoleANTHROPIC_API_KEY(quick-start.mdx:86-88) — a Claude Pro/Max subscriber cannot reuse their subscription and must mint a metered API key. Fix: add a note on which Claude auth methods are/aren't supported (subscription OAuth vs console key vs WIF) directly in quick-start.how-they-work.mdx:26); 35 example workflows omitengine:entirely and resolve to Copilot.--engine claudeexists (cli.md:142) but isn't surfaced in the quick-start add flow. Fix: show--engine claudein the primary add example and state the default explicitly.quick-start.mdx:71,86-88). Fix: give each engine a parallel secret block.Minor confusion
quick-start.mdx:29).architecture.mdx:279,286).customengine has 0 standalone examples;crushappears insecrets bootstrap --enginelist but is undocumented (cli.md:258).quick-start.mdbut the real file isquick-start.mdx.Engine & Tool Matrix
--engineneededcopilot-requests:write(no PAT) orCOPILOT_GITHUB_TOKENengine: claude/--engine claude(cli.md:142)ANTHROPIC_API_KEYonly in these docs; WIF/OAuth not surfacedengine: codexOPENAI_API_KEY(CODEX_API_KEYaccepted)engine.id: customoverlayengine.envbase-urlTool classification (
tools.md): 14 tools — 13 engine-agnostic, 1 engine-dependent (web-search: disabled-by-default on Codex,tools.md:65-67). 0 Copilot-only, 0 Claude-only tools. Ambiguous:githubis listed built-in but is effectively a GitHub MCP server (tools.md:29-39).Parity (engine-example-counter): Copilot >> Claude > Codex >> Custom. Copilot dominates example coverage (~2× Claude, ~9× Codex); Claude nonetheless has broad, varied coverage (smoke + daily + real workflows) and leads the inline
engine: claudestring form. Custom is effectively undemonstrated. Each engine has a dedicated smoke test — a positive.Auth Gaps
quick-start.mdx+cli.md;tools.md,how-they-work.mdx,architecture.mdxcarry zero auth guidance, andREADME.md:40lists engines with no setup pointer.ANTHROPIC_API_KEYpath is documented in these 6 files — no Bedrock/Vertex, model selection, or subscription-OAuth note (quick-start.mdx:86-88). (Trend note: WIF keyless auth exists inauth.mdxbut is out of this run's 6-file scope and remains absent from quick-start.)GH_AW_PROJECT_GITHUB_TOKENfor project creation surfaced only in the cli.md project section, not the general auth flow (cli.md:865).architecture.mdx:269-270) — good to state, but jarring without framing.Recommended Actions
Priority 1 — In quick-start, add an explicit note on supported Claude auth methods (console
ANTHROPIC_API_KEYyes; subscription/OAuth token status; WIF alternative) so subscription users aren't surprised.Priority 2 — Surface
--engine claudein the primary add example and state that omittingengine:silently defaults to Copilot; give Codex/Gemini the same dedicated secret block as Copilot/Anthropic.Priority 3 — Add a why-choose-which-engine paragraph, document the default Claude model, add at least one standalone
customexample, and documentcrush.References: §28741263826 · §28706632535 · §28662189611
Beta Was this translation helpful? Give feedback.
All reactions