Skip to content

UX: Convert 'Getting Help' run-on sentence to numbered list in errors.md #31722

Closed

Description

@github-actions

Problem

The Getting Help section in docs/src/content/docs/troubleshooting/errors.md (line 362) presents four remediation steps as a single run-on sentence:

If you encounter an error not documented here, search this page (Ctrl+F / Cmd+F) for keywords, review workflow examples in the documentation, enable verbose mode with gh aw compile --verbose, or report issues on GitHub. See Common Issues for additional help.

Users experiencing an error are already under cognitive load. The most immediately useful action (gh aw compile --verbose) is buried as the third item in a comma-separated list.

Proposed Change

File to modify: docs/src/content/docs/troubleshooting/errors.md (single file, line 360–363)

Before:

## Getting Help

If you encounter an error not documented here, search this page (Ctrl+F / Cmd+F) for keywords, review workflow examples in the documentation, enable verbose mode with `gh aw compile --verbose`, or [report issues on GitHub](https://github.com/github/gh-aw/issues). See [Common Issues](/gh-aw/troubleshooting/common-issues/) for additional help.

After:

## Getting Help

If you encounter an error not documented here:

1. Enable verbose mode for details: `gh aw compile --verbose`
2. Search this page (Ctrl+F / Cmd+F) for keywords from the error message
3. Review [workflow examples](/gh-aw/examples/) in the documentation
4. Check [Common Issues](/gh-aw/troubleshooting/common-issues/) for additional guidance
5. [Report the issue on GitHub](https://github.com/github/gh-aw/issues) if it is not documented

Why This Matters

  • Users can scan and act on each step independently
  • Promotes the most useful step (verbose mode) to the top
  • Matches the numbered-step pattern used elsewhere in troubleshooting docs
  • Converts a 5-second skim-fail into an instant action guide

Scope

  • Single file: docs/src/content/docs/troubleshooting/errors.md
  • Change is 5 lines; no other files need to change

Design Principle

Efficiency and Productivity — reduce cognitive load by formatting sequential actions as a numbered list.

📊 User experience analysis by Delight · ● 19.6M · ◷

  • expires on May 14, 2026, 3:41 PM UTC

Activity

  1. github-actions commented on May 13, 2026

    @github-actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · ● 60.7K · ◷

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

Metadata

Metadata

Labels

cookieIssue Monster Loves Cookies!delight

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions