🔍 Claude Code User Documentation Review - 2026-03-09 #20274
Closed
Replies: 1 comment
-
|
This discussion was automatically closed because it expired on 2026-03-10T22:37:09.859Z.
|
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
gh-aw is well-positioned for Claude Code users with no critical blockers preventing adoption. The quick start guide explicitly lists Claude as a supported AI account, the
add-wizardcommand walks users through Claude engine selection andANTHROPIC_API_KEYconfiguration, and 34 real-world Claude-engine workflow examples exist in the repository. However, several persistent documentation gaps create friction: the architecture diagram still hardcodes "Copilot CLI" as the agent label, the GitHub Web Interface workflow-creation path is gated by Copilot access with no Claude alternative shown, and theadd-wizardcommand is central to the quick start but absent from the CLI reference documentation.Key Finding: Claude Code users can successfully adopt gh-aw, but will encounter moderate friction from Copilot-centric framing in diagrams, examples, and some guides. Score remains 7/10 for the 17th consecutive day — all 11 previously reported issues remain unresolved.
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?
Yes, with some friction. The Quick Start guide (
docs/src/content/docs/setup/quick-start.mdx) is largely engine-agnostic and explicitly calls out Claude as a valid option in Prerequisites, Step 2, and secret setup. Thegh aw add-wizardcommand interactively asks which engine to use, making the path to Claude configuration smooth.However, the
How They Workpage (docs/src/content/docs/introduction/how-they-work.mdx) says on line 26: "Workflows support GitHub Copilot (default), Claude by Anthropic, and Codex." This omits Gemini entirely, which is now a documented fourth engine. This creates a first impression that gh-aw is primarily a Copilot tool with Claude as an add-on rather than an equal partner.Specific Issues Found:
docs/src/content/docs/introduction/how-they-work.mdxline 26 — Lists "Copilot (default), Claude by Anthropic, and Codex" — omits Gemini despite it being a fully documented enginedocs/src/content/docs/setup/creating-workflows.mdxlines 20-23 — GitHub Web Interface section opens with "If you have access to GitHub Copilot, you can create workflows directly from the Web Interface" with no alternative path shown for Claude Code usersdocs/src/content/docs/setup/quick-start.mdxline 62 — Usesgh aw add-wizardcommand which does not appear in the CLI reference (docs/src/content/docs/setup/cli.md)Recommended Fixes:
how-they-work.mdxto list all four engines: "Copilot (default), Claude by Anthropic, Codex, and Gemini"creating-workflows.mdxthat Claude Code users can use the terminal/CLI path in the next section as an equivalentadd-wizardto the CLI reference documentation under "Getting Workflows"Question 2: Inaccessible Features for Non-Copilot Users
What features or steps don't work without Copilot?
Features That Require Copilot:
creating-workflows.mdxlines 20–57 are gated by "If you have access to GitHub Copilot" (Copilot Chat required for/agentprompts)/agent agentic-workflowscommands —custom-agent-for-aw.mdxdescribes using/agent agentic-workflows create,/agent agentic-workflows debug, etc. — these require Copilot Chat or VSCode Agent Mode with Copilot. No equivalent documented for Claude Code users.assign-to-agentsafe output with Copilot —assign-to-copilot.mdxis specifically for assigning the Copilot coding agent; this is a Copilot-only feature and correctly documented as such.Features That Work Without Copilot (engine-agnostic):
gh aw init,compile,run,list,status,logs,audit,health,mcpgithub,playwright,cache-memory,bash,edit,web-fetch,repo-memory,agentic-workflowscreate-issue,add-comment,create-pull-request, etc.gh aw add-wizard(Claude option in wizard)Missing Documentation:
/agent agentic-workflowscommands — Claude Code users cannot use this workflow-authoring workflow at all without guidancecustom-agent-for-aw.mdxpage title says "Copilot Agent Files support for Agentic Workflows" and is entirely Copilot-focused with no Claude Code equivalentQuestion 3: Documentation Gaps and Assumptions
Where does the documentation assume Copilot usage?
Copilot-Centric Language Found In:
docs/src/content/docs/introduction/architecture.mdxlines 177, 248 — The AWF (Agent Workflow Firewall) mermaid diagram labels the agent container as"Copilot CLI"and"Copilot CLI + MCP client". These are architectural diagrams showing the system design, but the labels are Copilot-specific when they should show generic "AI Agent" or list all engines.docs/src/content/docs/introduction/architecture.mdxlines 222–233 — The only network configuration example usesengine: copilot, without noting that thenetwork:field is engine-agnostic.docs/src/content/docs/setup/creating-workflows.mdxlines 20–23 — Opens with a Copilot-gated section without offering a Claude Code alternative for the same web-based workflow creation experience.docs/src/content/docs/reference/custom-agent-for-aw.mdx— Entirely Copilot-focused; no mention of how Claude Code users can achieve equivalent workflow-authoring assistance.Missing Alternative Instructions:
/agent agentic-workflowsworkflow-creation taskscommon-issues.mdSeverity-Categorized Findings
🚫 Critical Blockers (Score: 0/10 — No Critical Blockers)
No critical blockers exist. A Claude Code user can install gh-aw, configure
ANTHROPIC_API_KEY, add a workflow, compile it, and run it without ever needing Copilot access.Obstacle 1: Architecture diagram hardcodes "Copilot CLI" as the agent
Impact: Significant confusion when reading the architecture docs
Current State:
docs/src/content/docs/introduction/architecture.mdxlines 177 and 248 show:Quality of Examples
Copilot Examples: Comprehensive; cover all major use cases including PR review, issue triage, daily reports, security scans, code quality, and advanced patterns.
Claude Examples: Good coverage; 34 examples including complex multi-tool workflows (
smoke-claude.mddemonstrates GitHub MCP, Serena MCP, Playwright, Tavily, bash tools all used together). Demonstrates Claude is a full-featured engine, not a second-class option.Codex Examples: Moderate; 10 examples exist including a dedicated
codex-github-remote-mcp-test.mdsmoke test.Gemini Examples: Missing entirely — 0 workflow files found using
engine: gemini.Recommended Actions
Priority 1: Critical Documentation Fixes
Fix ANTHROPIC_API_KEY setup URL — Change
(platform.claude.com/redacted) tohttps://console.anthropic.com/settings/keys` indocs/src/content/docs/reference/auth.mdxline 104. This is a navigation dead-end for users trying to create their API key.Document
add-wizardin CLI reference — Addadd-wizardas a documented command indocs/src/content/docs/setup/cli.mdunder "Getting Workflows". It's the primary Quick Start onboarding command but is invisible to users looking for CLI reference documentation.Update
how-they-work.mdxto include Gemini — Line 26 should read "GitHub Copilot (default), Claude by Anthropic, Codex, and Gemini" to accurately reflect all supported engines.Priority 2: Major Improvements
De-Copilot the architecture diagrams — In
architecture.mdxlines 177 and 248, replaceCOPILOT["Copilot CLI"]and"Copilot CLI + MCP client"with engine-agnostic labels to avoid implying Copilot is the only engine.Add Claude Code path to
creating-workflows.mdx— The GitHub Web Interface section (lines 20–57) is Copilot-gated. Add a callout directing Claude Code users to the terminal section, or document the equivalent Claude Code prompt for creating a workflow usingcreate.md.Add Gemini to
secrets bootstrap --enginedocs —cli.mdline 161 lists(copilot, claude, codex)but omitsgemini. Update to(copilot, claude, codex, gemini).Add Claude section to
custom-agent-for-aw.mdx— The "Other Agents and Chats" section (line 130) mentions compatibility with other AI tools but doesn't show a concrete example for Claude Code. Add a brief code example showing how Claude Code users can usecreate.mdas context.Priority 3: Nice-to-Have Enhancements
common-issues.md— Document common Claude authentication failure modes (invalid API key, billing limits) analogous to the "Copilot CLI Not Found" and "Copilot License Issues" sections.engine: geminito ensure Gemini is a viable, tested option.web-search.mdguide reportedly shows only Copilot examples; add a Claude equivalent showing the MCP-based alternative.engine-agnosticcallout to network config example — Inarchitecture.mdxlines 222–233, note that thenetwork:configuration works the same for all engines.Positive Findings
What Works Well
add-wizardonboarding covers Claude — The interactive wizard prompts for engine choice and correctly sets upANTHROPIC_API_KEYsmoke-claude.mdis a showcase of Claude engine capabilitiesinit,compile,run,logs,audit,healthall work identically for ClaudeCLAUDE_CODE_OAUTH_TOKEN— Explicitly documents that OAuth is not supported, onlyANTHROPIC_API_KEYcreating-workflows.mdxincludes Claude in heading — "VSCode/Claude/Codex/Copilot" signals multi-engine supportConclusion
Can Claude Code Users Successfully Adopt gh-aw?
Answer: Yes, with minor friction
Reasoning: The core workflow — install extension, run
add-wizard, choose Claude, setANTHROPIC_API_KEY, get first workflow running — is fully documented and Claude-friendly. The interactiveadd-wizardis the key path, and it handles all engine choices equally. The 34 existing Claude workflow examples in the repo demonstrate that gh-aw is actively used with Claude in production.The friction points are primarily cosmetic and documentation quality issues: architecture diagrams that say "Copilot CLI" when they should say "AI Agent", a GitHub web interface section that's Copilot-only, and missing
add-wizarddocumentation in the CLI reference. None of these prevent a Claude Code user from successfully using gh-aw, but they do create moments of confusion and a subtle impression that Copilot is the "real" engine.Overall Assessment Score: 7/10
Breakdown:
Score stable at 7/10 for 17 consecutive days (since ~2026-02-21). All 11 previously reported issues remain open.
Next Steps
The most impactful single change would be fixing the
ANTHROPIC_API_KEYsetup URL and documentingadd-wizardin the CLI reference — both are small edits with high user-facing impact. The architecture diagram Copilot labels are the highest-visibility cosmetic issue. No critical blockers require urgent attention.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/reference/tools.mddocs/src/content/docs/setup/cli.mddocs/src/content/docs/reference/engines.mddocs/src/content/docs/reference/auth.mdxdocs/src/content/docs/reference/faq.mddocs/src/content/docs/setup/creating-workflows.mdxdocs/src/content/docs/reference/custom-agent-for-aw.mdxdocs/src/content/docs/reference/editors.mdx.github/workflows/smoke-claude.md(example workflow analysis)Report Generated: 22877791352
Workflow: claude-code-user-docs-review
Engine Used: claude (eating our own dog food! 🐕)
Score Trend: 7/10 for 17 consecutive days
Beta Was this translation helpful? Give feedback.
All reactions