[claude-code-user-docs-review] 🔍 Claude Code User Documentation Review - 2026-06-01 #36257
Closed
Replies: 1 comment
-
|
This discussion has been marked as outdated by Claude Code User Documentation Review. A newer discussion is available at Discussion #36456. |
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 avoids GitHub Copilot products can adopt gh-aw today — there are no hard blockers. Tools are 100% engine-agnostic, the
add-wizardflow explicitly offers Claude, and Claude auth is thoroughly documented. The friction is framing, not capability: Copilot is the silent default engine, the docs lean Copilot-first, and the one caveat that bites this persona —CLAUDE_CODE_OAUTH_TOKENis not supported — is buried in a reference page, not the Quick Start.Key finding: gh-aw is engine-neutral under the hood but Copilot-first on the surface. Closing the gap is mostly doc reordering, not new infrastructure.
Persona Context
Severity Findings
0 Critical · 4 Major · 5 Minor. Zero criticals is honest: every Copilot-only path I checked has a documented Claude alternative.
🚫 Critical Blockers (0) — none found
No feature, tool, install step, or setup path requires Copilot/Copilot CLI with no Claude alternative.
quick-start.mdx:29).quick-start.mdx:70).auth.mdx:103-114).M1 — Copilot is the silent default engine. A workflow with no
engine:field runs on Copilot, needingCOPILOT_GITHUB_TOKEN: Workflows support GitHub Copilot (default), Claude, Codex, and Gemini (how-they-work.mdx:26; default=copilotconfirmed inpkg/constants). Any path bypassing the wizard prompt (copying a sample,gh aw newwithout--engine, hand-authoring) silently produces a Copilot workflow that fails for a Claude-only user. Already acknowledged inREADME.md:237→ #32423: Quick Start sample defaults to Copilot — Claude-only users will fail their first run.M2 —
CLAUDE_CODE_OAUTH_TOKENis not supported, and the warning is buried. A Claude Code user's instinct is subscription/OAuth auth. gh-aw rejects it: the only supported method for the Claude engine is ANTHROPIC_API_KEY; provider OAuth (Claude Teams/Max) is not supported... it will be ignored (auth.mdx:123). This persona-critical caveat lives only in the reference page — absent from Quick Start and CLI docs where secrets are first set up.M3 — No standalone end-to-end Claude-only walkthrough. Claude is only an alternative branch in a Copilot-default narrative. The reader must stitch: choose Claude in wizard (
quick-start.mdx:70) + setANTHROPIC_API_KEY(quick-start.mdx:84-88) + setengine: claudeshown as optional Step 4 (quick-start.mdx:129-133) + recompile (quick-start.mdx:124).M4 —
gh aw initproduces Copilot artifacts by default. The fix —gh aw init --engine claudeto skip Copilot-specific artifacts — appears only in the CLI reference (cli.md:135-140), never in the Quick Start.💡 Minor Confusion (5)
m1 — Copilot-first language/examples: Copilot (default) (
how-they-work.mdx:26); firewall example usesengine: copilot(architecture.mdx:228); engine diagram lists Copilot first (architecture.mdx:279).m2 — No Why-Claude-vs-Copilot guidance and no engine capability comparison.
m3 — CLI examples lead with Copilot:
secrets bootstrap --engine copilotshown first (cli.md:246).m4 — Zero Claude-engine examples in docs guides/examples (e.g.
guides/network-configuration.mdusesengine: copilot). Claude parity exists in repo workflows but not in the docs examples.m5 — GitHub-UI secret path under-specified: only
gh secret set+ a vague or use the GitHub UI (quick-start.mdx:81,87); UI location (Settings → Secrets → Actions) never spelled out.Engine Comparison
✅ strong · 🟡 adequate ·⚠️ gap · ❌ missing. Score = 1–10 Claude-user readiness.
quick-start.mdx:77-81)COPILOT_GITHUB_TOKENdocumentedauth.mdx:103-123);OPENAI_API_KEY(engines.md:18)engine: customvalue; only per-engine customization + 1 sharedgenaiscriptimportTool Availability
14 of 14 documented tools are engine-agnostic; 0 engine-specific — the biggest reason Claude adoption is viable. The
tools:frontmatter is unified; engine differences are limited to runtime behavior (web-search defaults) and per-engine timeout defaults, not availability.copilot— not a tool; only a provider API-target override in the config schemaNotable:
agentic-workflows,playwright,githubare all engine-agnostic (tools.md:29-39,69-79,116-127).web-searchis declared uniformly but Codex disables it by default (tools.md:62-67). There is nocopilottool to worry about.Authentication Gaps
Claude auth content is good; placement is the problem.
ANTHROPIC_API_KEYstep-by-step (auth.mdx:103-114), engines table row (auth.mdx:20), troubleshooting (auth.mdx:199).auth.mdx:123) — never in Quick Start/CLI (M2).quick-start.mdx:71,87,cli.md:251), with no inline pointer for the manualengine: claudepath.ANTHROPIC_BASE_URL/OPENAI_BASE_URLdocumented but not whether the API key is still required (engines.md:157-178).engine: customrow in the engines table (engines.md:14-22).Example Parity
Claude has strong parity inside the repo (64 workflows:
ci-doctor.md,daily-security-red-team.md, etc.) — plenty to copy. But the docs' own examples are 100% Copilot/default; a reader who only reads the docs never sees a Claude example (m4). Copilot's effective share is ~65% once defaults are attributed.Recommended Actions
Priority 1: (1) Surface the
CLAUDE_CODE_OAUTH_TOKEN-unsupported caveat in Quick Start + CLI secrets docs (M2). (2) Add a standalone Get-started-with-Claude path / makeengine: claudea Step-2 decision (M3). (3) Document the silent Copilot default and addgh aw init --engine claudeto Quick Start (M1, M4).Priority 2: (4) Add ≥1
engine: claudeexample to docs guides/examples (m4). (5) Add an engine-comparison page (m2).Priority 3: (6) Spell out the GitHub-UI secret path (m5); clarify custom-endpoint credentials in
engines.md; balance CLI examples (m3).Conclusion
Can Claude Code users adopt gh-aw? Yes. The architecture is genuinely engine-neutral: every tool is agnostic, Claude is a first-class prerequisite, the wizard offers it, and Claude auth is documented end-to-end. The remaining friction is presentation — a Copilot default that surprises, an OAuth caveat buried in reference docs, and Claude examples that exist in the repo but not the docs.
Overall Claude-user adoption score: 7.5 / 10.
References:
Beta Was this translation helpful? Give feedback.
All reactions