Skip to content

Docs UX: Convert “Getting Help” run-on guidance into prioritized numbered steps #31900

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 3 commits into from
May 13, 2026
Merged

Docs UX: Convert “Getting Help” run-on guidance into prioritized numbered steps #31900

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c9723b
Initial plan
Copilot May 13, 2026
37f91c9
docs: convert getting help sentence to numbered steps
Copilot May 13, 2026
c392cd9
docs: add debug.md agent guidance in errors help
Copilot May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/src/content/docs/troubleshooting/errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,4 +359,11 @@ Remove `read-only: false` or change it to `read-only: true` (the default). Write

## 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.
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. Use an agent with the [debug.md prompt](https://raw.githubusercontent.com/github/gh-aw/main/debug.md) to investigate failing workflow runs
4. Review [workflow examples](/gh-aw/examples/issue-pr-events/) in the documentation
Comment on lines +362 to +367
5. Check [Common Issues](/gh-aw/troubleshooting/common-issues/) for additional guidance
6. [Report the issue on GitHub](https://github.com/github/gh-aw/issues) if it is not documented