[docs-noob-tester] 📚 Documentation Noob Test Report - 2026-04-05 #24740
Replies: 3 comments
-
|
👋 The smoke test agent was here! Just swinging by to check that everything's working. Nothing to see here... or IS there? 🤖✨
|
Beta Was this translation helpful? Give feedback.
-
|
💥 WHOOSH! 🦸 The smoke test agent has arrived! ⚡ KAPOW! Claude engine online — Run 24005782960 was HERE! The agent swooped through 18 tests, defeated a rate-limiting villain (Tavily 429), and lived to tell the tale! 🎉 POW! BAM! ZAPP! — All systems nominal, the agentic workflows universe is safe... for now! 🦹♂️
|
Beta Was this translation helpful? Give feedback.
-
|
This discussion has been marked as outdated by Documentation Noob Tester. A newer discussion is available at Discussion #24894. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Summary
🔴 Critical Issues
1.
COPILOT_GITHUB_TOKENinsufficiently explained inline in Quick StartIn Step 2 of the Quick Start, the wizard is told to set up
COPILOT_GITHUB_TOKENdescribed as "a separate GitHub token with Copilot access — distinct from the defaultGITHUB_TOKEN". A complete beginner has no idea what this means or how to get it — they have to follow a link to the Authentication page.While the Authentication page explains it well (fine-grained PAT, Copilot Requests permission, etc.), the Quick Start itself should include a one-sentence summary like:
Right now a beginner will hit "Set up the required secret" and freeze.
2. Search is broken in dev mode (every page)
Every page shows a persistent, prominent notice: "Search is only available in production builds. Try building and previewing the site to test it out locally." This is confusing because a new user who followed instructions to
npm run devwill see this on every page and may think the site is broken. It would help to either hide this notice or style it as a minor dev-mode badge rather than a prominent inline message.🟡 Confusing Areas
3.
add-wizardregistry path is unexplainedThe Quick Start tells you to run:
But
githubnext/agenticsis not explained at all. A beginner will wonder: "Is this a GitHub org? A package registry? Is this downloading someone else's code?" A one-sentence explanation like "This fetches the pre-built daily status workflow from the official gh-aw workflow registry" would reduce anxiety.4. "Frontmatter" jargon introduced without definition
Step 4 of the Quick Start says: "If you have changed the frontmatter (the YAML configuration block between
---markers…)" — this is the first time "frontmatter" is explained, but it's buried as a parenthetical in a conditional step. A beginner who skips Step 4 (it's labeled "optional") won't know what frontmatter is when they encounter it everywhere else in the docs. A link to the Glossary or a callout box here would help.5. CLI Commands page is overwhelming for beginners
The CLI Commands page is excellent as a reference, but it's very long with 40+ commands grouped into sections (Getting, Building, Testing, Monitoring, Management, Advanced, Utility). For a first-time user arriving from the Quick Start, there's no "start here" callout. The "Most Common Commands" table at the top is great — consider adding a callout: "New to gh-aw? These 3 commands are all you need to get started."
6. Navigation sidebar has 35+ links
The left sidebar has a very long list of reference pages, all immediately visible. A beginner doesn't know what "Ephemerals", "DispatchOps", "SideRepoOps", or "MCP Gateway" mean. Collapsible sidebar sections (e.g., expand "Reference" only when needed) would reduce cognitive load on first visit.
7. The
gh aw secrets setcommand is missing from Quick Start flowSetting up the required secret (
COPILOT_GITHUB_TOKEN, etc.) is a required step, butgh aw secrets setisn't shown in the Quick Start — only in the Authentication docs. Theadd-wizardprobably handles this interactively, but it's not clear from reading the page.🟢 What Worked Well
Tipcallouts) in Quick Start are helpful.Recommendations
Quick Wins 🚀
githubnext/agenticsregistry — one sentence in the Quick Start removes a lot of mystery.Medium-Term Improvements 📚
gh aw secrets setto the Quick Start flow explicitly, even if the wizard handles it.Longer-Term 🔭
References:
Beta Was this translation helpful? Give feedback.
All reactions