[claude-code-user-docs-review] 🔍 Claude Code User Documentation Review - 2026-07-16 #45994
Closed
Replies: 1 comment
-
|
This discussion has been marked as outdated by Claude Code User Documentation Review. A newer discussion is available at Discussion #46245. |
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
As a Claude Code user, I can adopt gh-aw — Claude is a first-class engine with documented
ANTHROPIC_API_KEYsetup. But every default points at Copilot, so a Claude user must actively fight the defaults at each step. Key finding: removingengine:from frontmatter silently reverts the runtime to Copilot with no warning or verification step (quick-start.mdx:75), andgh aw initgenerates Copilot-specific artifacts unless you know to pass--engine claude(cli.md:148).Severity Findings (Critical → Major → Minor)
🔴 Critical Blockers
engine:is removed, the runtime defaults to Copilot with no warning — a Claude user can unknowingly run (and be billed) on Copilot.quick-start.mdx:75. Fix: emit a compile-time warning and document agh aw status/verify step.gh aw initdefaults to Copilot artifacts. Claude users must already know to pass--engine claudeto skip them.cli.md:148,153. Fix: prompt for engine during init, or surface this in the quick-start happy path.🟠 Major Obstacles
how-they-work.mdx:26andarchitecture.mdx:42name four engines but give zero secret/setup guidance; auth is deferred to a linked reference. Fix: inline theANTHROPIC_API_KEYstep near first mention.web-searchMCP dependency unnamed. Docs say it "requires third-party MCP servers for some engines" without naming which or how to configure.tools.md:65. A Claude user cannot tell if web-search works out of the box. Fix: name the engines and link config.tools.md:157) and Codex web-search-off (tools.md:67) appear in prose with no single per-engine defaults table.🟡 Minor Confusion
web-searchandtools.timeoutare engine-ambiguous in the tools reference.tools.md:65,157.COPILOT_GITHUB_TOKENis a separate token fromGITHUB_TOKEN(quick-start.mdx:81) — presented up front, but noise for Claude users.README.md:52) is engine-agnostic and fine.Engine & Tool Matrix
copilot-requests: writeorCOPILOT_GITHUB_TOKEN--engine claude/engine: claudeANTHROPIC_API_KEY--engine codexOPENAI_API_KEY/CODEX_API_KEYshared/genaiscript.md)Parity observations (from workflow scan): Copilot dominates ~2:1 over Claude; Codex ~8× fewer than Copilot; Custom has zero standalone examples; 33 engine-less files silently inflate Copilot's real footprint. The ecosystem skews heavily to Copilot even though the docs describe all engines as peers.
Tool classification: 12 engine-agnostic, 2 ambiguous (
web-search,tools.timeout), 0 Copilot-only. Good news — the tools are genuinely engine-neutral; the friction is in defaults, examples, and auth surfacing, not tool availability.Auth Gaps
Required secrets by engine are correct where documented — Claude:
ANTHROPIC_API_KEY(quick-start.mdx:98); Codex:OPENAI_API_KEY/CODEX_API_KEY(:102); Gemini:GEMINI_API_KEY(:112). Gaps for a Claude user:how-they-work.mdx:26/architecture.mdx:42name engines but give no auth instructions.web-searchMCP dependency for "some engines" is unnamed (tools.md:65).README.md:39,cli.md:268).quick-start.mdx:75).Recommended Actions
Priority 1 — Add a compile-time warning +
gh aw status/verify step for the silent Copilot fallback; prompt for engine ingh aw initinstead of defaulting to Copilot artifacts.Priority 2 — Inline a per-engine auth + defaults table near the first engine mention in
how-they-work.mdx/architecture.mdx; name the engines that need a third-party MCP server forweb-search.Priority 3 — Rebalance examples: add a Claude-engine example set (or engine-neutral variants) so Claude users have copyable patterns comparable to Copilot's 124.
Note: cache-memory (
review-history.jsonl) write was blocked by the session sandbox (path outside working dir), so trend history could not be updated this run.Beta Was this translation helpful? Give feedback.
All reactions