[claude-code-user-docs-review] 🔍 Claude Code User Documentation Review - 2026-04-13 #26035
Closed
Replies: 1 comment
-
|
This discussion has been marked as outdated by Claude Code User Documentation Review. A newer discussion is available at Discussion #26220. |
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 developer who uses Claude Code and deliberately avoids GitHub Copilot, I reviewed the gh-aw documentation to assess whether a non-Copilot user can successfully understand and adopt this tool. The documentation has matured significantly: the core adoption path (install extension →
gh aw add-wizard→ pick Claude engine → setANTHROPIC_API_KEY) is well-documented and works without Copilot access. However, 7 persistent documentation issues remain unaddressed for 5–13 consecutive days, and no fixes were observed in today's run — the third consecutive day with zero changes to these issues.Key Finding: Claude Code users can successfully adopt gh-aw (0 critical blockers), but face moderate friction from Copilot-centric language in architecture diagrams, Gemini omissions in introductory docs, and a suboptimal
ANTHROPIC_API_KEYsetup URL. Overall score: 7.5/10 (unchanged for 3 days).Persona Context
I reviewed this documentation as a developer who:
Question 1: Onboarding Experience
Can a Claude Code user understand and get started with gh-aw?
Answer: Yes, mostly. The Quick Start guide (
docs/src/content/docs/setup/quick-start.mdx) explicitly lists Anthropic Claude as a valid AI option in the prerequisites section:The
gh aw add-wizardcommand (Step 2) is interactive and guides users through engine selection, setting up the correct secret (ANTHROPIC_API_KEY,COPILOT_GITHUB_TOKEN, orOPENAI_API_KEY) automatically. This is the strongest part of the onboarding experience for non-Copilot users.Specific Issues Found:
Issue 1:
quick-start.mdxprerequisites and the Step 2 description both list only three engines (Copilot, Claude, Codex) but Gemini is missing despite being a fully supported 4th engine with complete documentation elsewhere. File:docs/src/content/docs/setup/quick-start.mdx(lines 29, 68).Issue 2:
how-they-work.mdx(line 26) lists "GitHub Copilot (default), Claude by Anthropic, and Codex" — again omitting Gemini. This is an introduction page that shapes first impressions. File:docs/src/content/docs/introduction/how-they-work.mdx.Recommended Fixes:
add-wizardstep descriptionhow-they-work.mdxengine list to include GeminiQuestion 2: Inaccessible Features for Non-Copilot Users
What features or steps don't work without Copilot?
Features that require Copilot:
engine.agent(custom agent files in.github/agents/) — Copilot-only per the engines feature comparison tablemax-continuations(autopilot mode) — Copilot-onlyassign-to-copilotsafe output — Copilot-only by designcreating-workflows.mdx) — gated behind a Copilot subscription (see Major Obstacle rejig docs #1 below)COPILOT_GITHUB_TOKENsecret — only needed for Copilot usersFeatures that work without Copilot (engine-agnostic):
create-issue,add-comment,create-pull-request, etc.)edit,bash,github,web-fetch,playwright,cache-memory)gh aw compile,gh aw run,gh aw logs,gh aw auditsecrets bootstrap --engine claudegh aw new --engine claudemax-turns(Claude-only feature, well documented)Missing Documentation:
Question 3: Documentation Gaps and Assumptions
Where does the documentation assume Copilot usage?
Copilot-Centric Language Found In:
docs/src/content/docs/introduction/architecture.mdx(lines 181, 252) — The AWF firewall diagram labels the agent container as"Copilot CLI"and"Agent container\nCopilot CLI + MCP client\n172.30.0.20". A Claude user reading the security architecture would see their engine misrepresented.docs/src/content/docs/setup/creating-workflows.mdx(lines 21–22, 104, 118–119) — The GitHub Web Interface authoring section opens with "If you have access to GitHub Copilot..." andgh aw initis described as enabling a "Copilot coding agent" dispatcher. No alternative is shown for Claude users.docs/src/content/docs/introduction/how-they-work.mdx(line 26) — Omits Gemini from engine list.Missing Alternative Instructions:
creating-workflows.mdxshould note thatgh aw new(terminal) or direct.mdfile editing are the equivalent paths for non-Copilot users.Severity-Categorized Findings
🚫 Critical Blockers — Score: 0/10 (none found)
No critical blockers exist. Claude Code users can fully adopt gh-aw without Copilot.
Obstacle 1: GitHub Web Interface Workflow Creation is Copilot-Gated [PERSISTENT — day 5]
Impact: Claude users following the "Creating Workflows" guide hit a wall at the first recommended method
Current State:
creating-workflows.mdxline 21–22 reads:Lines 104, 118–119 describe
gh aw initas setting up a "Copilot coding agent" dispatcher. No alternative workflow-creation path is surfaced for Claude users in the same section.Why It's Problematic: A Claude Code user reading this section would conclude they cannot use the web interface and might miss the alternative terminal-based path (
gh aw new).Suggested Fix: Add a note immediately after the Copilot-gated section: "Don't have Copilot? Use
gh aw newin the terminal or edit workflow.mdfiles directly in your editor." Alternatively, rename the VSCode/Claude/Codex section heading to be more prominent.Affected Files:
docs/src/content/docs/setup/creating-workflows.mdxObstacle 2: Architecture AWF Diagram Mislabels Agent as "Copilot CLI" [PERSISTENT — day 10]
Impact: Misleads Claude/Codex/Gemini users about the system architecture
Current State:
architecture.mdxlines 181 and 252:Claude has strong example representation (54 workflows, ~29% of total). The repo itself uses Claude as its primary engine for many production workflows (this very review workflow runs on
engine: claude), demonstrating real-world parity.Recommended Actions
Priority 1: Critical Documentation Fixes (Low effort, high impact)
ANTHROPIC_API_KEYsetup URL — Change(platform.claude.com/redacted) tohttps://console.anthropic.com/settings/keys` — File:auth.mdxline 109 (PERSISTENT 13 days)"Copilot CLI"with"AI Agent CLI"in both mermaid diagrams — File:architecture.mdxlines 181, 252 (PERSISTENT 10 days)anthropic.com/index/claudetoanthropic.com/claude— File:engines.mdline 17 (PERSISTENT 13 days)Priority 2: Major Improvements
creating-workflows.mdx— Surfacegh aw newas the equivalent for non-Copilot users immediately after the Copilot-gated web UI section (PERSISTENT 5 days)quick-start.mdxlines 29, 68 (PERSISTENT 13 days)how-they-work.mdxengine list — File:how-they-work.mdxline 26 (PERSISTENT 7 days)Priority 3: Nice-to-Have Enhancements
cli.mdsecrets bootstrap--engineoption list — File:cli.mdPositive Findings
gh aw add-wizardinteractively handles engine selection and secret setup for all enginesauth.mdxexplicitly warns thatCLAUDE_CODE_OAUTH_TOKENis NOT supported — critical for Claude Code usersANTHROPIC_API_KEYsetup instructions with troubleshootinggh aw new --engine claudeinjects engine into frontmatter automaticallymax-turns(Claude-only) andANTHROPIC_BASE_URL(custom endpoint) are well-documentedengine: claude— the project eats its own dog foodConclusion
Can Claude Code Users Successfully Adopt gh-aw?
Answer: Yes, with minor effort.
The core adoption path is well-designed and engine-agnostic. The
add-wizardcommand handles engine selection interactively, authentication docs are comprehensive, and there are 54 real Claude engine workflows demonstrating production viability. A motivated Claude Code user can be up and running in under 10 minutes without touching any Copilot documentation.The friction points are documentation polish issues, not architectural ones: a Copilot-centric architecture diagram, Gemini omissions in introductory pages, a suboptimal setup URL, and a Copilot-gated web authoring path with no alternative surfaced. None of these block adoption — but they create a "second-class citizen" impression that reduces confidence.
Overall Assessment Score: 7.5/10 (unchanged for 3 consecutive days)
Trend
All 7 previously identified issues remain unresolved. No documentation changes were observed today — the third consecutive day with zero fixes. The issues are collectively small in scope (most are 1–2 line changes) but their persistence suggests they may not be on the team's radar.
Appendix: Files Reviewed
Complete List of Documentation Files Analyzed
README.mddocs/src/content/docs/setup/quick-start.mdxdocs/src/content/docs/introduction/how-they-work.mdxdocs/src/content/docs/introduction/architecture.mdxdocs/src/content/docs/introduction/overview.mdxdocs/src/content/docs/reference/tools.mddocs/src/content/docs/setup/cli.mddocs/src/content/docs/reference/auth.mdxdocs/src/content/docs/reference/engines.mddocs/src/content/docs/reference/github-tools.mddocs/src/content/docs/reference/faq.mddocs/src/content/docs/setup/creating-workflows.mdx.github/workflows/*.md(187 workflow files analyzed for engine distribution)References:
Beta Was this translation helpful? Give feedback.
All reactions