[claude-code-user-docs-review] 🔍 Claude Code User Documentation Review - 2026-06-06 #37309
Closed
Replies: 1 comment
-
|
This discussion has been marked as outdated by Claude Code User Documentation Review. A newer discussion is available at Discussion #37551. |
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 developer who uses Claude Code and deliberately avoids GitHub Copilot can adopt gh-aw — Claude is a first-class engine (
engine: claude),ANTHROPIC_API_KEYsetup is documented in two places, every documentedtools:entry is engine-agnostic, andgh aw init --engine claudeskips all Copilot scaffolding. There are no Critical blockers. The friction is structural: GitHub Copilot is the documented default engine, and all 7 example workflows indocs/.../examples/set no engine — so a Claude user who copies an example silently runs on Copilot and is asked forCOPILOT_GITHUB_TOKENthey neither have nor want.Persona Context
Severity Findings
🚫 Critical Blockers (none found)
No documentation gap fully prevents a Claude Code user from starting. Claude is supported end-to-end:
engine: claude—quick-start.mdx:131quick-start.mdx:84-87andreference/auth.mdx:103-125(console URL atauth.mdx:109)gh aw init --engine claude—setup/cli.md:140M1 — Copilot is the default engine; a Claude user must opt out everywhere.
Verified in source:
pkg/constants/engine_constants.go:34(DefaultEngine = CopilotEngine). Any workflow that omitsengine:runs on Copilot. Fix: state the default consequence next to every "engine optional" mention, and add a one-line "Using Claude? addengine: claude" callout in Quick Start Step 4 (quick-start.mdx:127-133).M2 — Every example workflow defaults to Copilot. All 7 files under
docs/src/content/docs/examples/**set no engine (the loneengine:hit independabot-rollout.mdis aconcurrencysub-block). A Claude user copyingexamples/maintaining-repos.mdorexamples/multi-repo.mdwill be prompted forCOPILOT_GITHUB_TOKEN. Fix: addengine: claude(or an engine-agnostic note) to example frontmatter, or a banner: "examples default to Copilot — changeengine:to match your account."M3 —
gh aw initproduces Copilot-specific scaffolding by default.The default
initwrites.github/skills/agentic-workflows/SKILL.mdand.github/agents/agentic-workflows.md(Copilot dispatcher artifacts). A Claude user must know to pass--engine claudeup front or they get Copilot-only files. Fix: surfacegh aw init --engine claudeas a first-class example at the top of the init docs, not a footnote.💡 Minor Confusion (paper cuts)
COPILOT_GITHUB_TOKEN—quick-start.mdx:70-71. (Mitigated: there is an inlineANTHROPIC_API_KEYNOTE box atquick-start.mdx:84-87.)max-turnsis Claude-only,max-continuationsis Copilot-only —reference/engines.md:37,41) but aren't framed as a decision aid.customengine is undocumented as an engine. There is noengine: customvalue anywhere indocs/— the substitute isengine.command/engine.harness/ custom endpoints (engines.md:130-217). Worth an explicit "there is nocustomengine; here's how to bring your own" note.Engine Comparison
quick-start.mdx:78-81); defaultauth.mdx:76-99)--engine claudedocumented (cli.md:140); inline NOTE (quick-start.mdx:84-87)auth.mdx:103-125)OPENAI_API_KEYorCODEX_API_KEY(auth.mdx:129-167)engine.command/harnessonly (engines.md:130-217)(occurrence = repo-wide
engine:frontmatter field count, includes docs/specs; treat as relative volume not a workflow census.)Tool Availability
tool-engine-classifierfound every documentedtools:entry is engine-agnostic — 0 copilot-only, 0 claude-only, 0 codex-only.github,bash,edit,web-fetch,playwright,cache-memory,repo-memory,mcp-serversreference/tools.md:20-210web-searchtools.md:61-67,engines.md:40agentic-workflowsactions: read, not engine)tools.md:116-127Note: there is no
copilottool — Copilot-specific knobs (engine.agent,engine.harness,max-continuations) live underengine:, nottools:. So a Claude user loses no tooling.Authentication Gaps
From
auth-doc-extractor(reference/auth.mdx):COPILOT_GITHUB_TOKENauth.mdx:76-99ANTHROPIC_API_KEYauth.mdx:103-125(+quick-start.mdx:84-87)OPENAI_API_KEY/CODEX_API_KEYauth.mdx:129-167CLAUDE_CODE_OAUTH_TOKENis not supported and silently ignored — onlyANTHROPIC_API_KEYworks (auth.mdx:121-123). A Claude Code user who expects to reuse their Claude subscription OAuth token will be confused; this is inauth.mdxbut not in Quick Start.Example Parity
engine-example-counter: Claude has broad coverage of core safe-outputs (create-issue, create-pull-request, add-comment/labels, mcp, github-remote-mcp, noop) across all engines, but Copilot-only fixtures exist for ~25 newer features (projects, review-thread resolve/submit, dispatch-workflow, comment-memory). Claude sample workflows:.github/workflows/scout.md,deep-report.md,smoke-claude.md.Recommended Actions
Priority 1 (close the silent-Copilot trap):
engine: claude(or an engine note) to the 7docs/.../examples/**workflows, or a prominent "examples default to Copilot" banner.ANTHROPIC_API_KEY."Priority 2 (reduce opt-out friction):
3. Promote
gh aw init --engine claudeto a top-level example insetup/cli.md.4. Surface the
CLAUDE_CODE_OAUTH_TOKEN-unsupported warning in Quick Start, not onlyauth.mdx.Priority 3 (parity & guidance):
5. Add an engine-capability comparison ("why Claude vs Copilot",
max-turnsvsmax-continuations).6. Add Claude examples for advanced safe-outputs to match Copilot fixture coverage.
7. Document that there is no
customengine; point toengine.command/engine.harness.Conclusion
Can Claude Code users adopt gh-aw? — Yes. Claude is genuinely first-class: documented auth, engine-agnostic tools, and a clean Copilot-free init path. The problems are defaults and discoverability, not capability — the biggest risk is a Claude user copying an engine-less example and being unexpectedly funneled into Copilot.
Overall adoptability score: 7.5 / 10 — fully usable today, held back by Copilot-default framing and example workflows that don't declare an engine.
References:
Beta Was this translation helpful? Give feedback.
All reactions