🔍 Claude Code User Documentation Review - 2026-03-02 #19274
Closed
Replies: 1 comment
-
|
This discussion was automatically closed because it expired on 2026-03-03T22:38:58.042Z.
|
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 Claude Code user reviewing gh-aw documentation for the tenth consecutive day, the overall picture remains stable: the docs are broadly accessible to non-Copilot users, but contain persistent Copilot-centric framing in several specific locations. All 11 previously identified issues remain unresolved.
Key Finding: Claude Code users can successfully adopt gh-aw. There are zero critical blockers. The engine selection wizard, auth docs, and CLI commands are all multi-engine-friendly. However, architecture diagrams and a few page sections are still Copilot-centric, creating unnecessary friction for Claude users.
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. The Quick Start (
docs/src/content/docs/setup/quick-start.mdx) is the strongest entry point for Claude users. Prerequisites explicitly list "Anthropic Claude" as a valid AI account. Thegh aw add-wizardcommand presents an interactive engine selector—Copilot, Claude, or Codex—and walks through settingANTHROPIC_API_KEY. No Copilot access is required to complete the Quick Start.Specific Issues Found:
creating-workflows.mdxline 21 opens the "GitHub Web Interface" section with "If you have access to GitHub Copilot, you can create and edit Agentic Workflows directly from the Web Interface." — This implies Claude users cannot use the web interface, with no alternative path shown for Claude/Codex users.creating-workflows.mdxstep 3 says "If not using Copilot, also adjust theengine:field" — this frames Copilot as the default/normal path and Claude as the exception requiring extra action.Recommended Fixes:
/agentor direct prompt in Claude Code).engine:field tocopilot,claude,codex, orgeminidepending on your AI provider."Question 2: Inaccessible Features for Non-Copilot Users
What features or steps don't work without Copilot?
Features That Require Copilot:
creating-workflows.mdx)assign-to-agentsafe output withname: copilot— Assigns Copilot coding agent to issues/PRs (assign-to-copilot.mdx); no Claude equivalent.github/agents/*.agent.md) — Engine-specific Copilot feature; Claude engine doesn't use this mechanismFeatures That Work Without Copilot (engine-agnostic):
gh aw init,compile,run,list,status,logs,audit,healthedit,github,bash,playwright,web-fetch,cache-memory,repo-memory,agentic-workflowsgh aw secrets set/bootstrap)Missing Documentation:
argsflags (e.g.--max-turns,--model)Question 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, 205, 248 — Firewall and MCP gateway diagrams show "Copilot CLI" as the only agent type inside the AI agent process container. Claude Code users may think these diagrams don't apply to them.docs/src/content/docs/introduction/architecture.mdxline 224 — Only configuration example fornetwork:usesengine: copilot; no Claude equivalent shown.docs/src/content/docs/introduction/how-they-work.mdxline 26 — Lists supported engines as "GitHub Copilot (default), Claude by Anthropic, and Codex" — omits Gemini, which is a supported engine documented inengines.mdandauth.mdx.docs/src/content/docs/reference/engines.mdline 75 — The "Extended Coding Agent Configuration" section showsmodel: gpt-5 # defaults to claude-sonnet-4withid: copilot— the comment "defaults to claude-sonnet-4" is incorrect for the Copilot engine and confusingly mixes engine names.Missing Alternative Instructions:
docs/src/content/docs/setup/cli.mddocuments many commands but does not includeadd-wizard, which is prominently featured in the Quick StartSeverity-Categorized Findings
🚫 Critical Blockers (Score: 0/10)
No critical blockers exist for Claude Code users. All core workflow creation, compilation, and execution paths work without Copilot.
Obstacle 1: Architecture diagrams are Copilot-centric
Impact: Confusion when reading security architecture documentation
Current State:
architecture.mdxlines 177/205 showCOPILOT["Copilot CLI"]and line 248 showsAGENT["Agent container\nCopilot CLI + MCP client\n172.30.0.20"]as nodes in architecture diagrams that describe the general AWF system, not Copilot-specific behavior.Why It's Problematic: Claude Code users reading security architecture docs will see "Copilot CLI" throughout and may believe the firewall/proxy system only works with Copilot. This is incorrect — these are engine-agnostic infrastructure components.
Suggested Fix: Replace "Copilot CLI" with "AI Engine (Copilot/Claude/Codex)" or "Coding Agent" in the diagrams. The MCP gateway diagram could say "Agent container\nCoding Agent + MCP client".
Affected Files:
docs/src/content/docs/introduction/architecture.mdxObstacle 2: Creating workflows page gates web interface on Copilot
Impact: Claude Code users skip a valid workflow creation path
Current State:
creating-workflows.mdxline 21: "If you have access to GitHub Copilot, you can create and edit Agentic Workflows directly from the Web Interface."Why It's Problematic: A Claude Code user sees this conditional and skips the section entirely, missing context about how the workflow generation prompt pattern works (which is the same prompt pattern they'd use with Claude Code).
Suggested Fix: Split into "Using Copilot on GitHub.com" (requires Copilot subscription) and "Using Claude Code or other coding agents" (no subscription needed) subsections.
Affected Files:
docs/src/content/docs/setup/creating-workflows.mdxObstacle 3: `add-wizard` command absent from CLI reference
Impact: Users cannot find documentation for a prominently featured command
Current State:
quick-start.mdxtells users to rungh aw add-wizard githubnext/agentics/daily-repo-statusas the primary onboarding step. However,cli.mdcontains no entry foradd-wizard— it's not listed in the commands table or the Commands section.Why It's Problematic: Users following the quick start, then turning to the CLI reference for more detail, find no documentation for this command.
Suggested Fix: Add an
add-wizardsection tocli.mddocumenting its behavior (interactive engine selection, secret setup, workflow addition, optional first run).Affected Files:
docs/src/content/docs/setup/cli.md,docs/src/content/docs/setup/quick-start.mdxObstacle 4: Incorrect ANTHROPIC_API_KEY setup URL
Impact: Claude users sent to documentation page instead of API key creation page
Current State:
auth.mdxline 104: "Create an API key at (platform.claude.com/redacted)Why It's Problematic:
platform.claude.com/docs/en/get-startedis a documentation page, not the API key creation interface. Claude users need to go tohttps://console.anthropic.com/settings/keysto create API keys. This is a dead-end for new users following setup instructions.Suggested Fix: Update the URL to
https://console.anthropic.com/settings/keysAffected Files:
docs/src/content/docs/reference/auth.mdxObstacle 5: Troubleshooting has zero Claude-specific entries
Impact: Claude users stuck on engine-specific errors have no guidance
Current State: The troubleshooting section (common-issues.md) contains multiple Copilot-specific entries (Copilot CLI Not Found, Copilot License or Inference Access Issues) but zero Claude-specific entries.
Why It's Problematic: Claude users hitting errors like invalid API key format, rate limits, or model availability issues have no documentation to consult.
Suggested Fix: Add a "Claude / Anthropic Issues" troubleshooting section with common errors: invalid
ANTHROPIC_API_KEY, rate limit handling, and model availability.Affected Files:
docs/src/content/docs/troubleshooting/common-issues.md💡 Minor Confusion Points (11 total)
how-they-work.mdxline 26 — Lists engines as "Copilot (default), Claude, and Codex" — omits Gemini (now a 4th supported engine)engines.mdline 75 —model: gpt-5 # defaults to claude-sonnet-4withid: copilot— comment mixes engine names incorrectlyarchitecture.mdxline 224 — Network config example shows onlyengine: copilot, no Claude equivalentcreating-workflows.mdxstep 3 — Frames Claude as exception ("If not using Copilot, also adjust..."), Copilot as the normcreating-workflows.mdxline 77 — Links to "VSCode Agent Mode" (Copilot) docs without Claude Code equivalent linkweb-search.md) — Only shows Copilot engine examples; no Claude equivalentcli.mdline 161 —secrets bootstrap --enginelists(copilot, claude, codex)— omits Geminicustom-agent-for-aw.mdx— Uses/agent agentic-workflowsslash command syntax (Copilot Chat/VSCode Agent Mode specific) with no Claude Code equivalent documentedcli.mdsecrets example — Showsgh aw secrets set COPILOT_GITHUB_TOKENas the example command; could use a neutral examplehow-they-work.mdx"Copilot (default)" — The "(default)" label may confuse new users into thinking Copilot is requiredEngine Comparison Analysis
Available Engines
engine: copilot— Excellent documentation; detailed troubleshooting; custom agent files featureengine: claude— Good documentation; clear auth setup (except URL); 36 real examplesengine: codex— Adequate documentation; fewer examplesengine: gemini— Exists in engines.md and auth.mdx but missing from how-they-work.mdx summary and secrets bootstrap CLI help textDocumentation Quality by Engine
Rating Scale: ⭐⭐⭐⭐⭐ (Excellent) to ⭐ (Poor/Missing)
Tool Availability Analysis
Engine-Agnostic Tools (work with any engine):
edit— File editinggithub— GitHub API operations (all toolsets)bash— Shell executionweb-fetch— Web content fetchingplaywright— Browser automationcache-memory— Persistent cross-run memoryrepo-memory— Repository-specific memoryagentic-workflows— Workflow introspectionmcp-servers:configurations)Engine-Specific Features:
agent:field — Custom agent files (.github/agents/*.agent.md); no Claude equivalentassign-to-agentsafe output — Assigns GitHub Copilot to issues; no Claude equivalentweb-search:— Works with all engines but some require additional MCP server setup (documentation unclear on which engines)Unclear/Undocumented:
web-search:engine compatibility — "Some engines require third-party MCP servers" (tools.md) but doesn't specify which engines need extra setupAuthentication Requirements
Current Documentation Coverage
COPILOT_GITHUB_TOKEN— Detailed instructions with fine-grained PAT setup linkANTHROPIC_API_KEY— Instructions present but URL points to docs page instead of API key creation pageOPENAI_API_KEY— Clear instructionsGEMINI_API_KEY— Clear instructionsMissing for Claude Users
https://console.anthropic.com/settings/keys, not `(platform.claude.com/redacted)Secret Names
COPILOT_GITHUB_TOKENANTHROPIC_API_KEYOPENAI_API_KEYGEMINI_API_KEYExample Workflow Analysis
Workflow Count by Engine
(Note: grep results were truncated; counts are approximate)
Quality of Examples
Claude Examples: 36 workflows covering security analysis, code metrics, doc updates, MCP integrations (Azure, Fabric RTI), safe output optimization, and more. Sufficient diversity. Real production workflows running in this repo (including this very review workflow
claude-code-user-docs-review.md).Copilot Examples: ~82 workflows covering the broadest range of use cases. Serves as the de facto "gallery" of what gh-aw can do.
Codex Examples: ~11 workflows; adequate for demonstrating the engine works but narrower coverage.
Recommended Actions
Priority 1: Critical Documentation Fixes
(platform.claude.com/redacted) tohttps://console.anthropic.com/settings/keys` inauth.mdx— directly blocks Claude users from completing setupadd-wizardin CLI reference — Add entry tocli.mdfor the command featured prominently in Quick Start — leaves users with no reference docs for a key commandarchitecture.mdxdiagrams — prevents Claude users from understanding that security architecture applies to themPriority 2: Major Improvements
Priority 3: Nice-to-Have Enhancements
cli.mdline 161 to includegeminiin the engine listmodel: gpt-5 # defaults to claude-sonnet-4under the Copilot section — the comment incorrectly implies Copilot defaults to a Claude modelPositive Findings
What Works Well for Claude Code Users
add-wizardis the best onboarding path — interactive, asks for engine, sets correct secrets automaticallyengine: claudefrontmatter is clearly documentedCLAUDE_CODE_OAUTH_TOKENis not supported, useANTHROPIC_API_KEYclaude-code-user-docs-review.mdusesengine: claudeand runs daily, demonstrating production-grade Claude usageConclusion
Can Claude Code Users Successfully Adopt gh-aw?
Answer: Yes, with minor friction
A Claude Code user who follows the Quick Start (
gh aw add-wizard) will successfully set up and run their first workflow without any Copilot dependency. The authentication docs cover Claude correctly (aside from the URL issue). All core CLI commands, tools, and MCP integrations are fully engine-agnostic.The friction comes from: (1) having to navigate past Copilot-first language in a few specific pages, (2) the incorrect Anthropic API key URL, and (3) the absence of Claude-specific troubleshooting. None of these are show-stoppers, but collectively they create a slightly unwelcoming experience for users who have consciously chosen Claude over Copilot.
Overall Assessment Score: 7/10 (stable — 10th consecutive day)
Breakdown:
Trend Note
This score has been 7/10 for 10 consecutive days. All 11 identified issues have been reported in previous reviews. The stability suggests these are either accepted design trade-offs (Copilot-first since Copilot is the default engine) or items in a backlog. The most actionable quick win remains fixing the
ANTHROPIC_API_KEYURL inauth.mdx.Appendix: Files Reviewed
Complete List of Documentation Files Analyzed
README.mddocs/src/content/docs/setup/quick-start.mdxdocs/src/content/docs/setup/creating-workflows.mdxdocs/src/content/docs/setup/cli.mddocs/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/reference/engines.mddocs/src/content/docs/reference/auth.mdxdocs/src/content/docs/reference/frontmatter.mddocs/src/content/docs/reference/assign-to-copilot.mdx.github/workflows/*.md(engine field survey, truncated at ~163 files)Report Generated: 22598742665
Workflow: claude-code-user-docs-review
Engine Used: claude (eating our own dog food 🐕)
Consecutive days at score 7/10: 10
Beta Was this translation helpful? Give feedback.
All reactions