Skip to content

[deep-report] Docs: add run-monitoring guidance to Quick Start Step 3 #40097

Description

@github-actions

Description

Quick Start Step 3 ("Wait for the workflow to complete") tells the user only that a run takes 2-3 minutes. The docs-noob tester had no idea where to look (Actions tab), how to check progress (is there a gh aw status?), what success looks like, or what to do on failure. The step ends without orienting the user.

Suggested approach

Add 2-4 short lines to Step 3 in docs/src/content/docs/setup/quick-start.mdx:

  • A link to the repository Actions tab to watch the run.
  • The gh aw status (and/or gh run watch) command to check progress from the CLI.
  • A one-line note on what success looks like (a new issue is created) and where to find logs if it fails.

Expected Impact

Closes the biggest orientation gap in onboarding: new users can actually observe their first run instead of guessing.

Suggested Agent

Docs maintenance agent or a general code agent.

Estimated Effort

Fast (< 30 min).

Data Source

DeepReport 2026-06-18; Documentation Noob Test Report #39985 (Critical #2).

Generated by 🔬 DeepReport - Intelligence Gathering Agent ·

  • expires on Jun 20, 2026, 8:03 AM UTC-08:00

Activity

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

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions