🔍 Claude Code User Documentation Review - 2026-03-24 #22695
Closed
Replies: 1 comment
-
|
This discussion has been marked as outdated by Claude Code User Documentation Review. A newer discussion is available at Discussion #22905. |
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
Reviewed gh-aw documentation from the perspective of a developer who uses Claude Code as their primary AI assistant and has no GitHub Copilot subscription. The good news: Claude Code users can fully adopt gh-aw — there are zero critical blockers, authentication is well-documented for Claude, and 39 real-world Claude engine workflow examples exist in the repo. However, three persistent documentation issues (now flagged across 3–4 consecutive weekly reviews) continue to create friction and confusion.
Key Finding: Claude users can get started successfully, but must navigate Copilot-centric language and a few misleading diagrams. The same three issues remain unfixed from the previous four review runs.
Trend: Stable at 7.5/10. One positive change this run: Gemini was added as a 4th supported engine in
engines.mdandauth.mdx— but this addition exposed a new consistency gap (quick-start and how-they-work don't mention Gemini yet).Persona Context
Documentation reviewed as a developer who:
Question 1: Onboarding Experience
Can a Claude Code user understand and get started with gh-aw?
Yes — and the quick start is impressively inclusive. The prerequisites section (
quick-start.mdx:29) explicitly lists all AI options: "GitHub Copilot, Anthropic Claude or OpenAI Codex." Theadd-wizardstep 2 provides a menu to choose between engines. Authentication is fully documented per-engine inauth.mdx.The workflow is:
gh extension install github/gh-aw✅gh aw add-wizard githubnext/agentics/daily-repo-status✅ANTHROPIC_API_KEYsecret ✅ (documented in auth.mdx)Specific Issues Found:
quick-start.mdx:68: Step 2 says "Choose between Copilot, Claude, or Codex" — Gemini is now a supported engine but isn't listed here. Minor, but inconsistent withengines.md.how-they-work.mdx:26: "Workflows support GitHub Copilot (default), Claude by Anthropic, and Codex." — Gemini is missing from this introductory statement despite being inengines.md.Recommended Fixes:
quick-start.mdxstep 2 text to include Gemini alongside Copilot, Claude, and Codexhow-they-work.mdx:26to add Gemini to the engines listQuestion 2: Inaccessible Features for Non-Copilot Users
What features or steps don't work without Copilot?
Features that genuinely require Copilot:
engine.agent(custom agent files in.github/agents/) — documented as Copilot-only inengines.mdfeature comparison table ✅ well-documentedmax-continuations(autopilot mode) — documented as Copilot-only ✅COPILOT_GITHUB_TOKEN— requires an active Copilot subscription ✅ clearly notedFeatures that work with any engine (including Claude):
edit,github,bash,web-fetch,playwright,cache-memory,repo-memory,qmd,agentic-workflowsmax-turns— Claude-only (not available for other engines)Missing Documentation:
architecture.mdxAWF section: the "Configuration Example" only showsengine: copilot. There is no note that the same configuration applies identically to Claude, Codex, and Gemini. A non-Copilot user might assume the firewall is Copilot-specific.Question 3: Documentation Gaps and Assumptions
Where does documentation assume Copilot usage?
Copilot-centric language found in:
architecture.mdx(AWF diagram, line ~177): The AI agent process is labeledCOPILOT["Copilot CLI"]— this is inside a generic diagram titled "AI Agent Process" that should represent any enginearchitecture.mdx(AWF config example): Usesengine: copilotas the only configuration example without noting it applies to all engineshow-they-work.mdx:26: Omits Gemini from the supported engines listquick-start.mdx:68: Omits Gemini from engine selection prompt descriptionMissing Alternative Instructions:
architecture.mdxAWF diagram should showENGINE["AI Engine\n(Copilot / Claude / Codex / Gemini)"]or similar generic labelcopilotwithclaude,codex, orgeminias needed"Severity-Categorized Findings
🚫 Critical Blockers: 0
No critical blockers were found. Claude users can adopt gh-aw without any hard dependencies on Copilot.
Obstacle 1: AWF Architecture Diagram Labels Agent as "Copilot CLI" (4th consecutive review)
Impact: A Claude user reading the architecture documentation will see the AI Agent box labeled as "Copilot CLI" — a Copilot-specific product they don't use and don't want. This creates confusion about whether the security architecture applies to them.
Current State (
architecture.mdxlines ~174–179):Claude Engine Examples — Quality Assessment
39 real-world Claude engine workflow examples exist. Notable examples:
safe-output-health.md— monitoring safe output operationsgo-fan.md— Go module dependency analysisdaily-code-metrics.md— code quality metricsstatic-analysis-report.md— static analysis automationaudit-workflows.md— workflow auditingclaude-code-user-docs-review.md— this very workflow 🐕Assessment: The 39 examples provide excellent real-world reference material for Claude users. They demonstrate diverse use cases: reporting, analysis, documentation maintenance, CI monitoring. Quality is high.
Gap: Zero Gemini workflow examples exist in the codebase, despite Gemini being added to the reference docs. New adopters of the Gemini engine have no examples to learn from.
Recommended Actions
Priority 1: Fix Persistent Issues (4 consecutive reviews)
Update AWF architecture diagram — Rename
COPILOT["Copilot CLI"]to a generic engine label inarchitecture.mdx(~line 177). This is a one-line change that has been flagged 4 times.Fix ANTHROPIC_API_KEY setup link — Change
(platform.claude.com/redacted) tohttps://console.anthropic.com/settings/keys` inauth.mdx. This is a one-line change that has been flagged 4 times.Add Gemini to how-they-work.mdx engine list — Update the introductory sentence at line 26 to include Gemini. One-line change flagged 3 times.
Priority 2: Consistency Updates (Gemini rollout)
Update quick-start.mdx step 2 — Add Gemini to "Choose between Copilot, Claude, or Codex" text at line 68.
Add Gemini workflow examples — Create at least one
engine: geminiworkflow in.github/workflows/to demonstrate the engine works end-to-end.Update AWF architecture config examples — Add a note to the "Configuration Example" blocks in
architecture.mdxclarifying thatengine: copilotis just an example and Claude/Codex/Gemini work identically.Priority 3: Nice-to-Have Enhancements
Add "Why Claude instead of Copilot?" guidance — A short comparison or use-case guide for choosing between engines would help non-Copilot users feel welcome rather than like second-class citizens.
Standardize direct-to-action auth links — Mirror the Copilot PAT pre-filled link experience for Claude, Codex, and Gemini auth setup pages.
Add engine-specific troubleshooting sections —
troubleshooting/common-issues.mdlikely focuses on Copilot errors; adding Claude-specific troubleshooting guidance would help.Positive Findings
What Works Well for Claude Code Users
add-wizardprovides interactive engine selectionauth.mdxhas a dedicated, clearly structuredANTHROPIC_API_KEYsectionengines.mdfeature comparison table — excellent, honest comparison of what each engine supportsgh aw new --engine claude— creates a Claude-specific workflow template immediatelygh aw secrets bootstrap --engine claude— Claude-aware secret validationmax-continuationsand custom agent filesclaude-code-user-docs-review.md) — runs onengine: claude, demonstrating real-world dogfoodingConclusion
Can Claude Code Users Successfully Adopt gh-aw?
Answer: Yes, with minor friction
The documentation has matured significantly in its multi-engine support. A Claude Code user can follow the quick start guide, select the Claude engine, set an
ANTHROPIC_API_KEY, and have a working workflow in under 10 minutes. The 39 existing Claude engine examples provide excellent reference material.The friction comes from three persistent documentation issues that have been flagged 3–4 consecutive times without being addressed: a mislabeled architecture diagram, a missing Gemini entry in the how-they-work introduction, and an auth link pointing to a docs page rather than the API console. None of these are blockers, but they create an impression of Copilot-centrism that may deter or frustrate non-Copilot users.
The recent addition of Gemini as a 4th supported engine is positive, but it created new consistency gaps (how-they-work still lists only 3 engines; quick-start still shows only 3 choices; zero Gemini workflow examples exist).
Overall Assessment: 7.5/10 (stable — 4th consecutive run at this score)
Next Steps
The three Priority 1 items are each single-line fixes that have been deferred for 3–4 review cycles. Addressing them would push the overall score to 8.5/10 and meaningfully reduce the Copilot-centric feel of the documentation.
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.md(partial).github/workflows/*.md(engine type distribution analysis)References:
Beta Was this translation helpful? Give feedback.
All reactions