[docs-noob-tester] 📚 Documentation Noob Test Report - September 26, 2026 #63549
Closed
Replies: 1 comment
|
This discussion was automatically closed because it expired on 2026-09-27T03:54:23.281Z.
|
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.
📝 Summary
🔴 Critical Issues Found
None found that would fully block a new user. All internal links referenced from the Quick Start page (prerequisites, auth references, engine pages, gallery, FAQ, workflow-structure reference, etc.) returned HTTP 200 — I did not encounter any 404s or broken links during this pass.
🟡 Confusing Areas
"Frontmatter" used before it's defined for a first-time reader — The Quick Start's first subsection heading is literally "YAML frontmatter," and the term recurs throughout (Step 4, CLI page). It is explained inline the first time ("the configuration block between the
---markers"), which is good, but a total beginner skimming headings before reading body text will hit the jargon wall immediately. 💡 Suggestion: Consider a one-line plain-English gloss right in the heading area or a tooltip/glossary link, since this term recurs on nearly every doc page.Five parallel authentication paths shown at once — The "Configuring authentication" section lists full instructions for Copilot, Claude, Codex, Gemini, and Pi back-to-back, even though the wizard only asks the user to pick one. A first-timer has to scroll past four irrelevant blocks to find their own path. 💡 Suggestion: Collapse each engine into a
<details>/tab so only the chosen engine's steps are visible by default (the "Configuring authentication" already implies the wizard prompts interactively, so the static doc doesn't need all five expanded simultaneously).Command ordering/scope not obvious on the CLI page — The CLI Commands page opens with an excellent "Day-one commands" table (a genuine 🟢 win, see below), but immediately after Installation it jumps into "Global Options" and "The
--pushFlag" — fairly advanced flags — before circling back to command-by-command detail (init,add-wizard,add,new...). A brand-new reader following the Quick Start won't yet know what--pushor nested command paths are, and this section appears before they're needed. 💡 Suggestion: Move "Global Options" and advanced flags after the core command walkthroughs, or add a "skip to core commands" anchor link right after Installation.Two similarly named "add" commands introduced without an obvious default recommendation for total beginners —
add-wizardvsaddvsneware clearly differentiated in a comparison table (nice touch), but the Quick Start guide itself only ever usesadd-wizard, while the CLI reference discusses all three with equal weight — a beginner bouncing between the two pages may wonder which one is "the real starting command." 💡 Suggestion: Cross-link from the CLI page'sadd/newsections back to "if you're just getting started, see Quick Start'sadd-wizardwalkthrough."🟢 What Worked Well
ghCLI version + auth check, and OS support, each as a concrete, checkable bullet.curl | bashalternative right next togh extension installanticipates a common real-world failure mode (extension auth issues) before the user even hits it.✅ Recommendations
Quick wins:
Longer-term:
add-wizard/add/newalready have a comparison table buried mid-page — surfacing it earlier would help first-time visitors self-route faster.📎 Screenshots
📎 [home.png] — Home page, full page capture. Asset URL: https://github.com/github/gh-aw/blob/assets/Documentation-Noob-Tester/bfe04de845f8b015432bec87bd1f0657d5bc8682848a2ebc4b04bce95c5fd99f.png?raw=true
📎 [quickstart.png] — Quick Start guide, full page capture. Asset URL: https://github.com/github/gh-aw/blob/assets/Documentation-Noob-Tester/8ef76fb7ad38fd43d6ace44849847184b943313766eb0619b70a43f9cfee6f9f.png?raw=true
📎 [cli.png] — CLI Commands reference, full page capture. Asset URL: https://github.com/github/gh-aw/blob/assets/Documentation-Noob-Tester/5b69ac8eba0db6dc8a729129b723e921964be87b9bf4c254988935bc1cd4d374.png?raw=true
Automated documentation walkthrough performed by a "noob" agentic test persona. No blocking issues found; feedback above is aimed at reducing friction for first-time readers.
Warning
Firewall blocked 1 domain
The following domain was blocked by the firewall during workflow execution:
clients2.google.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:See Network Configuration for more information.
All reactions