[claude-code-user-docs-review] 🔍 Claude Code User Documentation Review - 2026-04-03 #24307
Closed
Replies: 1 comment
-
|
This discussion has been marked as outdated by Claude Code User Documentation Review. A newer discussion is available at Discussion #24491. |
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 avoids GitHub Copilot entirely, I reviewed the gh-aw documentation for the fifth consecutive day. The docs have matured into a multi-engine-friendly resource: Quick Start, Auth, and Engines pages all treat Claude as a first-class option. No critical blockers exist for Claude Code users. However, five persistent minor issues remain unresolved for a second or fifth consecutive day — the same set identified in previous runs, with no new issues and no fixes.
Key Finding: Claude Code users can successfully adopt gh-aw today. The onboarding path is clear, authentication is documented, and 35 example workflows use
engine: claude. The five open issues are low-severity but are accumulating days without resolution.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 (
docs/src/content/docs/setup/quick-start.mdx) now clearly lists "Anthropic Claude" as a supported AI Account in prerequisites. Thegh aw add-wizardstep explicitly mentions choosing between Copilot, Claude, or Codex, and referencesANTHROPIC_API_KEYalongside the Copilot token. The How They Work page (docs/src/content/docs/introduction/how-they-work.mdx) states: "Workflows support GitHub Copilot (default), Claude by Anthropic, and Codex." — clear and engine-neutral.Specific Issues Found:
docs/src/content/docs/setup/quick-start.mdx, line 29): Prerequisites list "GitHub Copilot, Anthropic Claude or OpenAI Codex" — Gemini is missing as the 4th supported engine (persists since day 1).docs/src/content/docs/setup/quick-start.mdx, line 68):add-wizarddescription says "Choose between Copilot, Claude, or Codex" — Gemini omitted again (persists since day 1).Recommended Fixes:
Question 2: Inaccessible Features for Non-Copilot Users
What features or steps don't work without Copilot?
Only one feature is genuinely Copilot-exclusive: the
assign-to-agentsafe output (docs/src/content/docs/reference/assign-to-copilot.mdx) — which programmatically assigns the Copilot coding agent to issues/PRs. This is clearly documented as Copilot-specific and makes logical sense given it's a Copilot product feature.Features That Require Copilot:
assign-to-agentsafe output (assigning GitHub Copilot coding agent to issues/PRs)engine.agentcustom agent files (Copilot-only per engines.md feature table)max-continuationsautopilot mode (Copilot-only)COPILOT_GITHUB_TOKEN(only needed for Copilot engine)Features That Work Without Copilot:
gh awCLI commandsmax-turns(Claude-only feature, a Claude advantage)Missing Documentation:
Question 3: Documentation Gaps and Assumptions
Where does the documentation assume Copilot usage?
The docs have largely moved past Copilot-only assumptions. A few residual areas:
Copilot-Centric Language Found In:
docs/src/content/docs/introduction/architecture.mdx, lines 181 and 252 — AWF Firewall diagram labels the agent process as"Copilot CLI". Claude users reading the security architecture see their engine misrepresented in the diagram.docs/src/content/docs/reference/custom-agent-for-aw.mdx— Entire page titled "Copilot Agent Files support for Agentic Workflows" with no equivalent Claude Code integration guide.docs/src/content/docs/guides/web-search.md, line 17 — Only example usesengine: copilot; no Claude MCP web search example shown.Missing Alternative Instructions:
Severity-Categorized Findings
🚫 Critical Blockers (Score: 0/10 — None)
No critical blockers found. Claude Code users can complete a full onboarding flow without Copilot.
Obstacle 1: ANTHROPIC_API_KEY Setup URL Is Incorrect (Day 5)
Impact: User follows auth setup link and lands on a docs overview page instead of the API key creation page.
Current State:
docs/src/content/docs/reference/auth.mdx, line 103:Note: Claude workflow count decreased by 2 from yesterday (35 vs 37). Likely due to normal workflow maintenance/refactoring rather than a concern.
Quality of Examples
Copilot Examples: Extensive coverage across a wide variety of use cases. Most community workflows default to Copilot.
Claude Examples: Good variety — includes
audit-workflows.md,blog-auditor.md,claude-code-user-docs-review.md,claude-token-optimizer.md,daily-doc-healer.md,daily-doc-updater.md, and more. Sufficient for a Claude user to find relevant templates.Recommended Actions
Priority 1: Quick Fix (< 30 min)
(platform.claude.com/redacted) tohttps://console.anthropic.com/settings/keys` indocs/src/content/docs/reference/auth.mdxline 103. Day 5 unresolved.docs/src/content/docs/setup/quick-start.mdx. Day 5 unresolved."Copilot CLI"to"AI Agent"indocs/src/content/docs/introduction/architecture.mdxlines 181 and 252. Day 2 unresolved.Priority 2: Low-Effort Improvements
anthropic.com/index/claudeindocs/src/content/docs/reference/engines.mdline 17. Day 5 unresolved.engine: claudevariant todocs/src/content/docs/guides/web-search.md. Day 5 unresolved.Priority 3: Nice-to-Have
Positive Findings
What Works Well
gh aw add-wizardhandles Claude engine selection interactively end-to-endauth.mdx) give Claude equal treatment alongside Copilotengine: claudeworkflows exist as reference materialgh aw init,gh aw new --engine claude, andgh aw secrets bootstrapall support Claude nativelymax-turnsis a Claude-exclusive feature that gives Claude users a unique capabilityConclusion
Can Claude Code Users Successfully Adopt gh-aw?
Answer: Yes
The documentation gives Claude Code users a complete path from zero to running their first workflow. The Quick Start is engine-inclusive, authentication is documented, and there are enough Claude engine workflow examples to learn from. The five open issues are real but none rises to a critical blocker — they represent polish opportunities rather than adoption barriers.
The most actionable item remains the ANTHROPIC_API_KEY URL fix (Priority 1, < 5 min change) which has now been open for 5 days.
Overall Assessment Score: 8/10 (unchanged)
Breakdown:
Trend
Score is stable. No regressions detected. No issues have been fixed across 5 days of tracking.
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/custom-agent-for-aw.mdxdocs/src/content/docs/reference/assign-to-copilot.mdxdocs/src/content/docs/guides/web-search.md.github/workflows/*.md(183 workflows surveyed, engine distribution analyzed)References:
Beta Was this translation helpful? Give feedback.
All reactions