Repository navigation
[claude-code-user-docs-review] Claude Code User Documentation Review - 2026-08-12 #52294
Closed
Replies: 1 comment
|
This discussion was automatically closed because it expired on 2026-08-13T12:44:24.164Z.
|
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
gh-aw's docs are functionally complete for Claude Code users — Claude has first-class engine support, its own auth secret (
ANTHROPIC_API_KEY), and appears in every engine list — but the docs are written Copilot-first: Copilot gets the fullest walkthroughs, the most worked examples, and is framed as the path requiring "no extra setup." A Claude Code user (no Copilot, no Copilot CLI) can succeed, but hits more friction and fewer worked examples than a Copilot user at nearly every step. Key finding: Copilot outnumbers Claude ~2.3x in.github/workflows/*.mdexample coverage (141 vs 62engine:directives), and theadd-wizardauth flow documents Copilot's PAT mechanics in full while Claude gets one generic sentence.Severity Findings
Critical / Major / Minor (click to expand)
Critical Blockers
claude login→CLAUDE_CODE_OAUTH_TOKEN) is explicitly rejected with no alternative offered for users who only have a Claude.ai subscription (not separate Anthropic Console API billing). A Claude Code user's natural assumption — "I'm already logged in, this should just work" — is wrong, and the docs don't soften the landing. (README.md:41,docs/src/content/docs/setup/quick-start.mdx:148-150,docs/src/content/docs/setup/cli.md:259)Major Obstacles
add-wizarddocuments Copilot's PAT flow in full detail (auto-opened prefilled token page, scope/resource-owner guidance, revalidation behavior) but Claude/Codex/Gemini/Pi share one generic sentence ("Prompts for missing API keys and secrets"). (docs/src/content/docs/setup/cli.md:169vs:180)gh aw init --engine claudeis documented only as skipping "Copilot-specific artifacts" — it never states what (if anything) is generated in their place for Claude. (docs/src/content/docs/setup/cli.md:151).github/workflows/*.mdskew heavily Copilot: 141engine: copilotdirectives vs 62claudeand 16codex. Smoke tests alone show 9 Copilot variants (Azure OpenAI key/Entra auth, ARM, MAI backend, SDK mode, sub-agents) vs 3 for Claude and 2 for Codex — a Claude user has no analogous template for equivalent auth/runtime permutations.web-search:tool support is called "engine-dependent," but only Codex's behavior (disabled by default, needs explicit declaration) is spelled out. Nothing states whether Claude Code has native web search or needs a third-party MCP server. (docs/src/content/docs/reference/tools.md:62-67)Minor Confusion
tools.timeoutdefaults are given for Claude (60s) and Codex (120s) only — Copilot/Gemini/Pi defaults are silently omitted, making the "applies to all tools" framing feel incomplete. (docs/src/content/docs/reference/tools.md:157)architecture.mdx:15lists Copilot/Claude/Codex/Gemini (no Pi), whilehow-they-work.mdx:26andREADME.md:54list Pi as a fifth built-in engine — unclear if Pi shares the same security guarantees.engine: customexists anywhere in.github/workflows/*.md; the only "custom" construct found is a nestedid: custominshared/genaiscript.md, making the "Custom" engine class effectively undocumented by example.docs/src/content/docs/setup/cli.md:1008-1019) has no Claude-specific entries (e.g., invalidANTHROPIC_API_KEY, WIF misconfiguration), unlike the depth given to Copilot auth issues elsewhere.Engine & Tool Matrix
copilot-requests: write) —cli.md:169-180copilot-requests: writeorCOPILOT_GITHUB_TOKEN—how-they-work.mdx:32cli.md:151,180ANTHROPIC_API_KEYor Anthropic WIF; OAuth not supported —README.md:41tools.md:62-67,157,181CODEX_API_KEY(precedence) orOPENAI_API_KEY—quick-start.mdx:152-157tools.md:184,how-they-work.mdx:67id: custom)Tool classification (
tools.md) is otherwise engine-agnostic and consistent (edit,bash,github,playwright,cache-memory, etc. all apply uniformly) — the imbalance is concentrated in auth walkthroughs and worked examples, not the tool reference itself.Auth Gaps
quick-start.mdx:148-150)add-wizardauth mechanics get a full paragraph; every other engine shares one sentence. (cli.md:169vs:180)gh aw initengine parity gap: unclear what artifacts (if any) get created for Claude/Codex/Gemini/Pi vs Copilot's skill + custom agent files. (cli.md:151)tools.md:62-67)Recommended Actions
Priority 1 (blocks adoption)
quick-start.mdx:148-150).Priority 2 (major friction)
2. Expand
add-wizarddocs with equivalent step-by-step detail for Claude/Codex/Gemini/Pi, matching the Copilot PAT walkthrough (cli.md:180).3. Document what
gh aw init --engine claudeactually generates (cli.md:151).4. Resolve web-search support explicitly per engine, not just Codex (
tools.md:62-67).5. Add 2–3 Claude-focused smoke-test examples covering auth/runtime variants analogous to the Copilot set.
Priority 3 (polish)
6. Reconcile the Pi-inclusion discrepancy between
architecture.mdx:15andhow-they-work.mdx:26.7. Fill in
tools.timeoutdefaults for Copilot/Gemini/Pi (tools.md:157).8. Add Claude-specific rows to the CLI troubleshooting table (
cli.md:1008-1019).Findings appended to
review-history.jsonlin cache-memory for trend tracking (first run — no prior baseline to compare).References:
All reactions