[claude-code-user-docs-review] 🔍 Claude Code User Documentation Review - 2026-09-27 #63838
Closed
Replies: 1 comment
|
This discussion has been marked as outdated by Claude Code User Documentation Review. A newer discussion is available at Discussion #64007. |
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 remain usable for Claude Code users — no critical blockers found today — but Copilot is still the clear "first-class" path: quick-start gives Copilot a full auth decision tree while Claude gets two bullets and an external link,
gh aw initonly auto-scaffolds a custom agent file + MCP wiring for Copilot, and Claude's example/smoke-test coverage sits at ~52% of Copilot's. Key finding: theCLAUDE_CODE_OAUTH_TOKENpitfall (a Claude Code user's most natural first auth attempt) is well-documented deep in reference pages but still has no inline callout in quick-start.mdx's Claude tab — the 20th consecutive daily run flagging this.Severity Findings
Critical / Major / Minor findings (click to expand)
Critical Blockers: None found this run.
Major Obstacles:
CLAUDE_CODE_OAUTH_TOKENsilently ignored, no inline warning in quick-start —docs/src/content/docs/setup/quick-start.mdx:145-153; explained only downstream atcli.md:240,engines/claude.md:22,reference/auth.mdx:218-220. The failure produces "an authentication error from the Claude CLI that never mentions the token" (cli.md:240).gh aw initscaffolding parity gap — Copilot auto-gets.github/agents/agentic-workflows.md+.github/mcp.json+copilot-setup-steps.yml; Claude/Codex/Gemini/Pi users must hand-author an equivalent with no worked example (cli.md:135-140,142).cli.md:161); Claude's WIF option is one line with no cost/complexity guidance (quick-start.mdx:151).Minor Confusion:
quick-start.mdx:72vs:148).reference/engines.md:56calls Claude web-search "native" with no opt-in qualifier, whilereference/tools.md:128says it's opt-in for Claude too — inconsistent phrasing between the two docs.cli.md:142("remaining steps are the same for every engine") understates the MCP/agent-file asymmetry described two paragraphs earlier in the same doc.ANTHROPIC_API_KEYbilling relates to an existing Claude Pro/Max/Team subscription — a plausible confusion point for subscribers assuming their plan covers Actions usage.Engine & Tool Matrix
cli.md:113-144,161)quick-start.mdx:145-153)ANTHROPIC_API_KEYor WIF; OAuth token unsupportedCODEX_API_KEYprecedence notedOPENAI_API_KEY/CODEX_API_KEYGEMINI_API_KEYor WIFCopilot-only features:
engine.agent,engine.harness,max-continuations, init scaffolding (reference/engines.md:50-63,cli.md:135-140). Claude-only: deprecatedengine.max-turnsalias. Codex's declarations are 93% nested-YAML-form (generated later) vs Claude's 34% nested — suggesting template drift across engine docs/examples over time.Auth Gaps
ANTHROPIC_API_KEYor Anthropic WIF;CLAUDE_CODE_OAUTH_TOKENexplicitly unsupported and silently ignored (reference/auth.mdx:218-220,reference/faq.md:486-488) — warning absent from quick-start's Claude tab itself.OPENAI_API_KEY;CODEX_API_KEYtakes precedence.GEMINI_API_KEYor Google WIF.copilot-requests: write) or fine-grained PAT (COPILOT_GITHUB_TOKEN) — most thoroughly documented path, including default-token detection logic (cli.md:161).model:prefix to Copilot/Anthropic/OpenAI auth, plus requirestools.github.mode: gh-proxyandtools.cli-proxy: true.Recommended Actions
Priority 1: Add an inline callout (matching the TIP/WARNING admonition style used elsewhere, e.g.
architecture.mdx:196,292) to quick-start.mdx's Claude auth subsection statingCLAUDE_CODE_OAUTH_TOKEN/claude logintokens are unsupported, where a Claude Code user would look first — not three links away.Priority 2: Give
gh aw init --engine claudea worked example of an equivalent agent file / MCP registration, or explicitly state none is provided and link a copy-pasteable template.Priority 3: Fix the anthropic.com → console.anthropic.com prerequisite link and align the
web-searchopt-in wording betweenreference/engines.mdandreference/tools.md.Tooling note:
.claude/agents/doc-reader.mdandengine-example-counter.mdstill lack the requiredname:frontmatter field and fail to register as agents (13th consecutive day of this issue); Edit permission to fix them was denied again this run. Analysis fell back to two general-purpose agents carrying the same instructions inline — finding quality is unaffected, but this is filed separately viamissing_tool.All reactions