Skip to content

[deep-report] Quick Start docs: 3 onboarding friction points (auth-tab hint, term re-linking, add-wizard push-vs-PR clarity) #57375

Description

@github-actions

Description

Documentation Noob Tester's 2026-08-31 report (discussion #57338) — a fresh first-time-user pass over /gh-aw/, /gh-aw/setup/quick-start/, /gh-aw/setup/cli/ — found 3 concrete "quick win" friction points, all confirmed still live in docs/src/content/docs/setup/quick-start.mdx:

  1. The "if you already have GitHub Copilot, start there" hint (line 71, Prerequisites) isn't repeated near the 5-tab auth section (<Tabs> at line 120), so a beginner scanning just the auth tabs has no in-context steer among Copilot/Claude/Codex/Gemini/Pi.
  2. "frontmatter" and "lock file" aren't re-linked to their reference pages when they reappear in Step 4, even though each is defined once earlier.
  3. Line 114 still says the workflow file is added "either by direct push or a pull request" with no explanation of when each happens or how the user can tell which occurred.

These are distinct from previously-closed doc-friction issues #55966 (fallback-path clarity, add-wizard vs add naming) and #56578 (step ordering, Copilot callout placement, CLI-page tip position) — none of those covered the auth-tab in-context hint, term re-linking in Step 4, or the push-vs-PR ambiguity.

Expected Impact

Three small, targeted quick-start.mdx edits directly addressing friction points found via live first-time-user testing, reducing onboarding confusion at the exact points a beginner gets stuck.

Suggested Agent

Documentation-focused agent / general-purpose — edit docs/src/content/docs/setup/quick-start.mdx: (a) add a one-line Copilot recommendation directly above the <Tabs> block at line 120, (b) link "frontmatter" and "lock file" to their reference pages on reappearance in Step 4, (c) clarify near line 114 when add-wizard pushes directly vs. opens a PR and how to tell which occurred.

Estimated Effort

Quick (< 1 hour)

Data Source

DeepReport Intelligence analysis, 2026-08-31 cycle, from Documentation Noob Tester discussion #57338.

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • api.anthropic.com

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "api.anthropic.com"

See Network Configuration for more information.

Generated by 🔬 Deep Report · claude · agent · 435.8 AIC · ⌖ 10.5 AIC · ⊞ 12.4K ·

  • expires on Sep 1, 2026, 11:06 PM UTC-08:00

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions