Repository navigation
[claude-code-user-docs-review] 🔍 Claude Code User Documentation Review - 2026-10-03 #65329
Closed
Replies: 1 comment
|
This discussion was automatically closed because it expired on 2026-10-04T14:09:26.149Z.
|
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 now supports Claude Code as a first-class engine with clear API-key setup, and the long-standing
CLAUDE_CODE_OAUTH_TOKENsilent-failure trap is documented in two places (quick-start.mdx:153,cli.md:240) — the critical blocker flagged in this review's first 16 runs remains resolved. The main friction left for non-Copilot adopters is structural:gh aw initstill auto-scaffolds a custom agent and MCP wiring only for Copilot (cli.md:139-140), and Claude has roughly half as many example/smoke-test workflows to learn from as Copilot (56 vs 110, ~1.96x). Key finding: a Claude Code user can fully set up and run gh-aw without Copilot, but must self-author the agent/MCP integration pieces that Copilot users get for free, with no concrete steps given for doing so.Severity Findings (Critical / Major / Minor)
Critical Blockers: None open this run.
Major Obstacles
gh aw initartifact-parity gap — Copilot gets an auto-generated custom agent (.github/agents/agentic-workflows.md) and MCP wiring (.github/mcp.json,copilot-setup-steps.yml); Claude/Codex users are told only to "author an agent file in your own agent's format" / "registergh aw mcp-serverin your own MCP host configuration" with zero concrete steps (cli.md:139-140)..github/workflows/*.md; Claude has far fewer reference patterns to copy from.quick-start.mdx:151), unlike the fully spelled-out API-key path right above it.gh aw doctorvalidates engine secrets likeANTHROPIC_API_KEY— its documented checks are limited togh auth/repo state (cli.md:256-273), leaving the only auth-troubleshooting signal a downstream CLI error.Minor Confusion
quick-start.mdx:72tells new users "If you already have GitHub Copilot, start there — it requires no extra account setup," which can read as Copilot being the recommended/default path even though Claude's path (API key) is comparably short.tools.timeoutdocs name only "Claude and Codex" defaults (60s), leaving Copilot/Gemini/Pi unaddressed (tools.md:237) — ambiguous whether the setting applies uniformly.customengine has 0 standalone example workflows; its only occurrence is nested insideshared/genaiscript.md, an include-only fragment — hard to find a worked example.model:prefix (how-they-work.mdx:36) rather than having its own secret, which isn't obvious on first read.Engine & Tool Matrix
quick-start.mdx:135-143)quick-start.mdx:147-153)CODEX_API_KEYprecedence noted (quick-start.mdx:159-163)how-they-work.mdx)shared/genaiscript.md)gh aw initartifactscli.md:139-140)COPILOT_GITHUB_TOKENorcopilot-requests: writeANTHROPIC_API_KEYor WIF (CLAUDE_CODE_OAUTH_TOKENunsupported,quick-start.mdx:153)OPENAI_API_KEY/CODEX_API_KEYCross-checked both YAML engine-declaration forms (
engine: claudeandengine:\n id: claude): copilot/claude ratio = 1.96x, codex/claude ratio = 1.36x, matching prior-run trends. 285 of 304 top-level workflow files declare an engine explicitly; 19 omit it (implicit default).Tool-feature support is mostly engine-agnostic by omission rather than by design: of 18 tool/feature rows sampled from
tools.md, only 4 state all-engine support explicitly, 2 are Copilot-only artifacts (cli.md:139-140), and 12 are "unclear" because the docs don't call out per-engine differences at all (e.g.cache-memory:,playwright:,mcp-servers:—tools.md:132-264).Auth Gaps
CLAUDE_CODE_OAUTH_TOKEN(fromclaude login) is unsupported and silently ignored; the resulting Claude CLI error "never mentions the token" (quick-start.mdx:153,cli.md:240) — documented, but only in these two spots, not cross-linked from a general troubleshooting page.gh aw mcp-serverin your own MCP host configuration" (cli.md:139-140) with no concrete steps — both point outside the reviewed doc set.gh aw doctor(cli.md:256-273) documentsgh auth/repo-state checks only; no stated behavior for missing/invalidANTHROPIC_API_KEY.quick-start.mdx:151,171) with zero inline detail, unlike the concrete API-key step lists beside them.ANTHROPIC_API_KEY) beyond the OAuth-rejection note; a subscriber could reasonably assume otherwise.Recommended Actions
Priority 1 — Give Claude/Codex users a concrete self-authoring recipe (or a
gh aw init --engine claudescaffold) to close the init artifact-parity gap (cli.md:139-140).Priority 2 — Replace the link-only WIF mentions with inline setup steps for Claude and Gemini (
quick-start.mdx:151,171), matching the API-key path's level of detail.Priority 3 — Add 3-5 more Claude example/smoke-test workflows to narrow the 1.96x example gap, and document whether
gh aw doctorvalidates engine secrets.Daily Claude Code adoption review. Prior-run history (41 runs since 2026-08-22) tracked in cache-memory
review-history.jsonl.All reactions