🔍 Claude Code User Documentation Review - 2026-02-24 #18230
Replies: 3 comments
-
|
🤖 Smoke test agent was here! Just passing through on my smoke-testing duties. Everything's running smoothly! The copilot smoke test agent officially visited this discussion at 2026-02-25T00:09:13Z. 🚀✨ (beep boop, this is an automated smoke test)
|
Beta Was this translation helpful? Give feedback.
-
|
💥 WHOOSH! 🦸 A mysterious figure drops from the sky, cape billowing... "SMOKE TEST AGENT — CLAUDE EDITION — WAS HERE!" ⚡ POW! All systems tested. All circuits firing! The agent surveys the battlefield, satisfied...
— Claude Smoke Test Agent, 2026-02-25 🦸♂️💨
|
Beta Was this translation helpful? Give feedback.
-
|
This discussion was automatically closed because it expired on 2026-02-25T22:39:41.448Z.
|
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Executive Summary
As a developer who uses Claude Code (not GitHub Copilot), I reviewed the gh-aw documentation to assess how accessible it is for non-Copilot users. The overall experience is reasonably accessible — the core path works well, prerequisites are honest, and authentication for Claude is documented. However, there are persistent, recurring friction points in secondary docs and examples that signal a Copilot-first design perspective. No critical blockers exist, but 6 significant pain points and 10 minor confusions remain unresolved from prior review cycles.
Key Finding: Claude Code users can successfully adopt gh-aw with some friction. The onboarding path (quick start + engines ref + auth ref) is solid. The friction lives in surrounding documentation — architecture diagrams, workflow creation guides, troubleshooting, and example counts — all of which have a Copilot-centric orientation.
Trend: This is the third consecutive daily review. The score remains stable at 7/10. No issues from the previous two reviews have been addressed. The ANTHROPIC_API_KEY URL issue (flagged Feb 22) remains 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 minor friction. The quick start guide (
docs/src/content/docs/setup/quick-start.mdx) correctly lists Claude as a valid AI Account option in prerequisites alongside Copilot and Codex. Thegh aw add-wizardcommand offers an interactive engine selection step that includes Claude, and the authentication reference documentsANTHROPIC_API_KEYclearly.The first-run experience via
add-wizardis genuinely engine-agnostic at the CLI level. A Claude user can complete the quick start without hitting any hard walls.Specific Issues Found:
creating-workflows.mdxline 21 — The "GitHub Web Interface" section opens with**If you have access to GitHub Copilot**, explicitly gating this path. There is no alternative workflow creation path for Claude Code users in the web interface section. File:docs/src/content/docs/setup/creating-workflows.mdxcreating-workflows.mdxline 96 — The step-by-step instructions say "If not using Copilot, also adjust theengine:field" — this implies adjusting the engine field is an afterthought and Copilot is the default everyone starts with. No proactive guidance for Claude-first users.add-wizardis the primary UX path shown in the quick start, but it is absent from thecli.mdcommands reference. A user who searches the CLI reference to understand whatadd-wizarddoes will find nothing. File:docs/src/content/docs/setup/cli.mdRecommended Fixes:
creating-workflows.mdxengine:field toclaude,codex, or leave defaultcopilot" rather than treating non-Copilot as an afterthoughtgh aw add-wizardincli.mdalongsidegh aw addQuestion 2: Inaccessible Features for Non-Copilot Users
What features or steps don't work without Copilot?
Features That Require Copilot:
creating-workflows.mdxexplicitly gates the web interface section with "If you have access to GitHub Copilot." No alternative web-based authoring path is provided. Claude Code users must use the CLI path./agent agentic-workflowsCopilot Chat command — Thecustom-agent-for-aw.mdxguide focuses on Copilot Chat's/agentcommand. While Claude Code users can still install the agent file and use the markdown with Claude Code directly, this is not explained.assign-to-agentsafe output with Copilot — Theassign-to-copilot.mdxpage documents assigning the Copilot coding agent to issues/PRs. Claude Code users cannot use this feature without Copilot. This is documented but could more clearly note the limitation upfront.Features That Work Without Copilot (Engine-Agnostic):
github:,edit:,bash:,playwright:,cache-memory:,repo-memory:,agentic-workflows:, custommcp-servers:create-issue,add-comment,create-pull-request,create-discussion,dispatch-workflowinit,add,compile,run,status,logs,audit,health,mcp,secretsweb-fetchtoolMissing Documentation:
web-search:tool is documented as "engine-dependent" but no table or guide clarifies which engines need an MCP server vs. have native supportQuestion 3: Documentation Clarity for Non-Copilot Users
Where does the documentation assume Copilot usage?
Copilot-Centric Language Found In:
docs/src/content/docs/introduction/architecture.mdx— Mermaid diagram (line 177) showsCOPILOT["Copilot CLI"]as the sole agent process in the AWF network diagram. A second diagram (line 248) labels the agent container"Agent container\nCopilot CLI + MCP client\n172.30.0.20". For a Claude user reading the architecture documentation, this creates a false impression that the system is Copilot-specific at the infrastructure level.docs/src/content/docs/setup/creating-workflows.mdx— The entire "GitHub Web Interface" section is Copilot-gated. The CLI authoring section recommends "VSCode Agent Mode" which is a Copilot product, before mentioning other coding agents.docs/src/content/docs/guides/web-search.md— The example workflow usesengine: copilotonly. No Claude equivalent shown.docs/src/content/docs/reference/engines.mdlines 74-75 — In the "Extended Coding Agent Configuration" example, the YAML block showsengine: id: copilotwithmodel: gpt-5 # defaults to claude-sonnet-4. This comment states the default model for the Copilot engine isclaude-sonnet-4, which is accurate (Copilot uses Claude models), but is jarring and confusing for a Claude Code user who expectsclaude-sonnet-4to be the Claude engine's model, not Copilot's.docs/src/content/docs/troubleshooting/common-issues.md— Only Copilot-specific troubleshooting sections exist (Copilot CLI Not Found, Copilot License or Inference Access Issues). No Claude-specific troubleshooting exists.docs/src/content/docs/reference/auth.mdxline 112 —ANTHROPIC_API_KEYsetup URL:(platform.claude.com/redacted) — This URL appears incorrect. The Anthropic API keys are athttps://console.anthropic.com`. Theplatform.claude.comURL may redirect or be a docs URL, not the actual key creation page. This issue was first flagged on 2026-02-22 and remains unresolved.Missing Alternative Instructions:
custom-agent-for-aw.mdxfor Claude Code users (how to use Claude Code'sCLAUDE.md/ project instructions with agentic workflows)ANTHROPIC_API_KEYis misconfigured or quota is exceeded)Severity-Categorized Findings
🚫 Critical Blockers (Score: 0/10)
None. A Claude Code user can successfully set up and run gh-aw workflows.
Obstacle 1: Architecture Diagrams Show Copilot CLI as the Only Agent
Impact: Significant confusion for Claude users reading architecture docs
Current State: Two mermaid diagrams in
architecture.mdxspecifically label the agent as "Copilot CLI". Line 177 showsCOPILOT["Copilot CLI"]and line 248 shows"Agent container\nCopilot CLI + MCP client\n172.30.0.20".Why It's Problematic: A Claude Code user reading the security architecture documentation (which is detailed and important) will see diagrams that make it appear the entire system is built around Copilot CLI. This undermines confidence that Claude is a first-class citizen.
Suggested Fix: Replace "Copilot CLI" with "AI Agent (Copilot/Claude/Codex)" in these diagram nodes.
Affected Files:
docs/src/content/docs/introduction/architecture.mdxlines 177, 248Obstacle 2: GitHub Web Interface Workflow Creation is Copilot-Only
Impact: Claude Code users cannot use the web interface creation path
Current State:
creating-workflows.mdxexplicitly states "If you have access to GitHub Copilot, you can create and edit Agentic Workflows directly from the Web Interface." No alternative is offered in this section.Why It's Problematic: For a Claude Code user who wants a quick, non-CLI way to create workflows, this section provides nothing useful. The section could at minimum note that Claude Code users can use the CLI path in the next section, or suggest using Claude Code directly in the terminal as an equivalent approach.
Suggested Fix: Add a note: "If you use Claude Code or another coding agent instead of Copilot, use the CLI authoring approach in the next section — it works with any coding agent."
Affected Files:
docs/src/content/docs/setup/creating-workflows.mdxlines 19-27Obstacle 3: ANTHROPIC_API_KEY Setup URL May Be Wrong (Unresolved, 3rd Day)
Impact: Claude users may be sent to the wrong URL when setting up their API key
Current State:
auth.mdxline 112: `Create an API key at (platform.claude.com/redacted)Why It's Problematic: The Anthropic API keys are created at
https://console.anthropic.com/api-keys, not at a documentation page.platform.claude.comappears to be a docs/marketing subdomain. This issue has been flagged in the cache for three consecutive review cycles (Feb 22, 23, 24) with no fix.Suggested Fix: Update the URL to
https://console.anthropic.com/api-keysAffected Files:
docs/src/content/docs/reference/auth.mdxline 112Obstacle 4: Web Search Guide Has No Claude Engine Example
Impact: Claude users who want web search must figure out the configuration themselves
Current State:
web-search.mdcontains a single complete workflow example usingengine: copilot. The tools reference notes "Some engines require third-party MCP servers for web search" but the guide doesn't show which engines this applies to or provide a Claude-specific example.Suggested Fix: Add a note clarifying which engines support native
web-search:vs. require a Tavily/Exa MCP server, and add a Claude-specific example.Affected Files:
docs/src/content/docs/guides/web-search.mdObstacle 5: No Claude-Specific Troubleshooting
Impact: When Claude engine workflows fail, users have no troubleshooting docs to consult
Current State: The troubleshooting guide has two Copilot-specific sections ("Copilot CLI Not Found", "Copilot License or Inference Access Issues") but zero Claude-specific sections.
Suggested Fix: Add a "Claude Engine Issues" section covering: invalid/expired
ANTHROPIC_API_KEY, rate limiting behavior, model selection errors.Affected Files:
docs/src/content/docs/troubleshooting/common-issues.mdObstacle 6: `add-wizard` Command Undocumented in CLI Reference
Impact: Users following the quick start who then look up the CLI reference are confused
Current State:
quick-start.mdxusesgh aw add-wizardas the primary onboarding command, and it appears in multiple example docs, butcli.md(the CLI commands reference) does not documentadd-wizardas a command.Suggested Fix: Add
add-wizarddocumentation tocli.mdin the "Getting Workflows" section alongsideadd.Affected Files:
docs/src/content/docs/setup/cli.md💡 Minor Confusion Points (10 identified)
engines.mdline 75 — Comment# defaults to claude-sonnet-4appears next tomodel: gpt-5inside acopilotengine block. This is saying Copilot uses Claude Sonnet as its default model, which is confusing to a Claude engine user who expects that to be their model. File:docs/src/content/docs/reference/engines.mdhow-they-work.mdxsays "GitHub Copilot (default)" but doesn't explain why Copilot is the default or what it means for Claude users (no behavioral difference, just needs engine: field). File:docs/src/content/docs/introduction/how-they-work.mdxREADME.mdcreating-workflows.mdxline 96 says "If not using Copilot, also adjust the engine: field" — frames non-Copilot usage as exceptional. Should be: "Set engine: to claude, codex, gemini, or leave blank for copilot (default)." File:docs/src/content/docs/setup/creating-workflows.mdxfaq.md"How is my code processed?" — The Copilot answer links to Copilot documentation, but the Claude/Codex answer just says "Uses respective providers' APIs with their data handling policies" with no link. A Claude user wanting to understand data privacy has no link to follow. File:docs/src/content/docs/reference/faq.mdcustom-agent-for-aw.mdx— Titled "Copilot Agent Files support for Agentic Workflows" but actually contains instructions useful for any coding agent. No mention of how Claude Code users can use equivalent context/instructions. File:docs/src/content/docs/reference/custom-agent-for-aw.mdxengine: copilotappears 44 times,engine: claudeappears 5 times,engine: codexappears 2 times across all docs. This creates an impression of Copilot-centricity even when the underlying feature set is equivalent.secrets bootstrap --engine copilotis mentioned as an option but the equivalent--engine claudeusage isn't highlighted in the quick start or auth guide. File:docs/src/content/docs/setup/cli.mdassign-to-copilot.mdxpage (which is Copilot-only) is listed in the auth reference and could confuse Claude users into thinking it's a general feature. A brief "This feature requires GitHub Copilot" note at the top would help. File:docs/src/content/docs/reference/assign-to-copilot.mdxEngine Comparison Analysis
Available Engines
Based on my review, gh-aw supports these engines:
engine: copilot— Default. Well-documented with detailed troubleshooting, web interface authoring, and custom agentsengine: claude— Fully functional. Clear setup docs, but fewer examples and no troubleshootingengine: codex— Functional. Documented in engines reference, minimal examplesengine: gemini— Functional. Documented in engines reference, minimal examples (newest addition)Documentation Quality by Engine
Rating Scale: ⭐⭐⭐⭐⭐ (Excellent) to ⭐ (Poor/Missing)
Tool Availability Analysis
Engine-Agnostic Tools (work with any engine):
github:— GitHub API operations, all toolsetsedit:— File editingbash:— Shell commandsplaywright:— Browser automationcache-memory:— Persistent memory across runsrepo-memory:— Repository-specific memoryagentic-workflows:— Workflow introspectionweb-fetch:— Fetch web contentmcp-servers:— Any MCP serverEngine-Specific / Partially Engine-Specific:
web-search:— Engine-dependent (some engines need a third-party MCP server, others may have native support)copilottool /assign-to-agentsafe output — Copilot only (assigns Copilot coding agent to issues/PRs)agent:field in engine config — Copilot custom agents onlyUnclear/Undocumented:
web-search:vs. require Tavily/Exa MCP server — not documented clearlyapi-proxy(token isolation) works for all engines or only Copilot — architecture docs imply Copilot onlyAuthentication Requirements
Current Documentation
platform.claude.com/docs/en/get-startedvsconsole.anthropic.com/api-keys)Missing for Claude Users
ANTHROPIC_API_KEYCLAUDE_CODE_OAUTH_TOKENFAQ entry is excellent — explicitly states it's not supported and onlyANTHROPIC_API_KEYworksSecret Names
COPILOT_GITHUB_TOKEN(documented, with video)ANTHROPIC_API_KEY(documented, setup URL needs verification)OPENAI_API_KEY(documented)GEMINI_API_KEY(documented)Example Workflow Analysis
Workflow Count by Engine (in docs)
Note: No
.github/workflows/*.mdfiles were found in the gh-aw repository itself (clean workflows directory).Quality of Examples
Copilot Examples: Comprehensive. Appear throughout quick start, guides, reference docs, and troubleshooting with many real-world scenarios (issue triage, PR review, CI doctor, daily reports, web search).
Claude Examples: Sparse but present. Found in:
engines.md(basic setup),faq.md(switching engines),deterministic-agentic-patterns.md(scheduling),serena.md(refactoring),network.md(network config). These are functional but narrowly scoped — no end-to-end Claude workflow example for new users.Recommended Actions
Priority 1: Critical Documentation Fixes
Fix ANTHROPIC_API_KEY setup URL — Change
(platform.claude.com/redacted) to the correct Anthropic Console URL for API key creation. *This has been flagged for 3 consecutive days without resolution.* File:docs/src/content/docs/reference/auth.mdx:112`Update architecture diagrams to be engine-agnostic — Replace "Copilot CLI" labels in mermaid diagrams with "AI Agent (Copilot/Claude/Codex/Gemini)". File:
docs/src/content/docs/introduction/architecture.mdx:177,248Document
add-wizardin CLI reference — The primary onboarding command is absent from the CLI reference. File:docs/src/content/docs/setup/cli.mdPriority 2: Major Improvements
Add Claude Code path in
creating-workflows.mdx— The web interface section explicitly gates on Copilot access. Add a note or alternative section for Claude Code users. File:docs/src/content/docs/setup/creating-workflows.mdx:21Add Claude-specific troubleshooting section — Mirror the Copilot-specific troubleshooting sections with equivalent Claude content. File:
docs/src/content/docs/troubleshooting/common-issues.mdAdd Claude engine example to web-search guide — The web search guide should show a Claude-specific workflow example alongside the Copilot one. File:
docs/src/content/docs/guides/web-search.mdClarify
web-search:engine compatibility — Document which engines have nativeweb-search:support vs. require an MCP server. File:docs/src/content/docs/reference/tools.mdPriority 3: Nice-to-Have Enhancements
Add an "Choosing an AI Engine" guide — A brief comparison of Copilot vs. Claude vs. Codex for different use cases would help users make an informed choice without having to read all engine docs
Add more Claude workflow examples — Aim for 15+ Claude engine examples across guides (vs. 5 today) to approach the practical coverage Copilot gets
Add data privacy links for non-Copilot engines — The FAQ's "How is my code and data processed?" section should link to Anthropic/OpenAI/Google data policies, not just Copilot's
Add Anthropic data processing link in auth page — Mirror the "See Copilot documentation" cross-reference with equivalent Anthropic link
Positive Findings
What Works Well for Claude Code Users
gh aw add-wizardinteractive engine selection includes Claudegh aw secrets bootstrap --engine claudeworks and is documentedANTHROPIC_API_KEY)CLAUDE_CODE_OAUTH_TOKEN— a proactive, Claude-user-specific answerhow-they-work.mdxmentions Claude and Codex alongside Copilot in the first paragraphConclusion
Can Claude Code Users Successfully Adopt gh-aw?
Answer: Yes, with minor effort
Reasoning: The functional path works. A Claude Code developer can install the extension, run
add-wizard, select Claude, provide theirANTHROPIC_API_KEY, and have a working workflow in ~10 minutes. The core documentation (quick start, engines reference, auth reference) is genuinely inclusive of Claude users. The pain points are real but not blocking — they manifest as extra searching, occasional confusion, and a subtle sense that the tool was designed with Copilot users as the primary audience.The main ongoing risk is the
ANTHROPIC_API_KEYURL pointing to what appears to be an incorrect setup URL — if a new Claude user follows that link and can't find how to create an API key, that's a real first-day failure point.Overall Assessment Score: 7/10
Breakdown:
Trend
Next Steps
The most impactful single fix would be updating the
ANTHROPIC_API_KEYsetup URL (Priority 1, item 1). This has been flagged three days in a row. After that, updating the architecture diagrams to remove Copilot-only branding would improve the experience for all non-Copilot engine users systematically.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/copilot-custom-agents.mddocs/src/content/docs/reference/custom-agent-for-aw.mdxdocs/src/content/docs/reference/assign-to-copilot.mdxdocs/src/content/docs/guides/web-search.mddocs/src/content/docs/troubleshooting/common-issues.md(sampled)Report Generated: 22372935606
Workflow: claude-code-user-docs-review
Review Date: 2026-02-24
Score Trend: 7/10 → 7/10 → 7/10 (stable, 3 days)
Engine Used: claude (eating our own dog food)
Beta Was this translation helpful? Give feedback.
All reactions