Skip to content

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

Merged
pelikhan merged 3 commits into
mainfrom
copilot/fix-getting-help-ux
May 13, 2026
Merged

pelikhan merged 3 commits into
mainfrom
copilot/fix-getting-help-ux

Conversation

Copilot AI commented May 13, 2026 •

Copy link
Copy Markdown
Contributor

The troubleshooting page’s Getting Help guidance was a single dense sentence, making the highest-value action (gh aw compile --verbose) harder to spot under error-time cognitive load. This updates the section to a scan-friendly, ordered action flow.

  • What changed

    • Replaced the run-on paragraph in docs/src/content/docs/troubleshooting/errors.md with a numbered list.
    • Reordered guidance to put verbose compilation first.
    • Clarified step wording for direct actionability and updated links to explicit destinations (workflow examples, common issues, GitHub issues).
  • Resulting structure

      1. Enable verbose mode
      1. Search page by error keywords
      1. Review workflow examples
      1. Check Common Issues
      1. Report on GitHub if undocumented
## 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

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/graphql
    • Triggering command: /usr/bin/gh gh repo view --json owner,name --jq .owner.login + "/" + .name -importcfg /tmp/go-build3978635608/b435/importcfg -pack /home/REDACTED/work/gh-aw/gh-aw/pkg/logger/example_test.go /home/REDACTED/work/gh-aw/gh-aw/pkg/logger/spec_test.go (http block)
    • Triggering command: /usr/bin/gh gh repo view --json owner,name --jq .owner.login + "/" + .name 64/pkg/tool/linux_amd64/vet n_test.go ctions-build/mairemote r 64/pkg/tool/linuupstream ctio�� test.go nomaly.go x_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh pr list --repo github/gh-aw --state all --author app/github-actions --search created:2026-05-11T23:58:00Z..2026-05-12T00:05:00Z --limit 1 --json number --jq .[0].number (http block)
  • https://api.github.com/orgs/owner/actions/secrets
    • Triggering command: /usr/bin/gh gh api /orgs/owner/actions/secrets --jq .secrets[].name on' --ignore-path ../../../.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api /orgs/owner/actions/secrets --jq .secrets[].name on' --ignore-pat--ignore-path --jq sv k/gh-aw/gh-aw -buildtags r: $owner, name:"prettier" --write '../../../**/*.json' '!../../../pkg/workflow/js/**/*.json' ---errorsas gh er ./../pkg/workflow/js/**/*.json' --ignore-path --jq sv -unreachable=falgit /tmp/go-build397-C trepo.git gh (http block)
  • https://api.github.com/orgs/test-owner/actions/secrets
    • Triggering command: /usr/bin/gh gh api /orgs/test-owner/actions/secrets --jq .secrets[].name on' --ignore-path ../../../.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api /orgs/test-owner/actions/secrets --jq .secrets[].name on' --ignore-path ../../../.pret.prettierignore /opt/hostedtoolc--jq bject.type] | @tsv -unreachable=falsh (http block)
  • https://api.github.com/repos/actions/ai-inference/git/ref/tags/v1
    • Triggering command: /usr/bin/gh gh api /repos/actions/ai-inference/git/ref/tags/v1 --jq [.object.sha, .object.type] | @tsv -unreachable=false /tmp/go-build3978635608/b236/vet.cfg g_.a h ../../../.pretgh (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/ai-inference/git/ref/tags/v1 --jq [.object.sha, .object.type] | @tsv bility_SameInputSameOutput252918260/001/stability-test.md infocmp /usr/sbin/sh s/data/action_pigh 64/pkg/tool/linuapi de sh -c ulls/1 infocmp /home/REDACTED/work/node_modules/.bin/node tierignore ache/go/1.25.8/x-1 e/git node (http block)
  • https://api.github.com/repos/actions/checkout/git/ref/tags/v3
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v3 --jq [.object.sha, .object.type] | @tsv se 8635608/b252/vet.cfg ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet .prettierignore --log-level=erro-1 (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v3 --jq [.object.sha, .object.type] | @tsv 2571613744/custom/workflows git sv (http block)
  • https://api.github.com/repos/actions/checkout/git/ref/tags/v5
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v5 --jq [.object.sha, .object.type] | @tsv 1/001/inlined-a.md 8635608/b057/vet.cfg sv (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v5 --jq [.object.sha, .object.type] | @tsv 54754154/001 -buildtags /tmp/go-build3978635608/b426/gitutil.test l -ifaceassert -nilfunc /tmp/go-build3978635608/b426/git--jq -tes�� ithub-script/git/ref/tags/v9 -test.v=true bject.type] | @tsv -test.timeout=10infocmp -test.run=^Test -test.short=truexterm-color /bin/sh (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v5 --jq [.object.sha, .object.type] | @tsv /ref/tags/v9 -trimpath sv -p github.com/githu-1 -lang=go1.25 node /tmp�� /ref/tags/v9 -goversion sv -c=4 -nolocalimports -importcfg /opt/hostedtoolcache/node/24.14.main (http block)
  • https://api.github.com/repos/actions/checkout/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv 3881106610/001 8635608/b164/vet.cfg .yml (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv se 8635608/b084/vet.cfg .cfg (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv se 8635608/b100/vet.cfg ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet (http block)
  • https://api.github.com/repos/actions/github-script/git/ref/tags/v8
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq [.object.sha, .object.type] | @tsv ithub-script/git/ref/tags/v9 -importcfg (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq [.object.sha, .object.type] | @tsv k/gh-aw/gh-aw/.github/workflows/api-consumption-report.md /tmp/TestParseDefaultBranchFromLsRemoteWithRealGitcustom_branch2610595720/002/work t json' --ignore-pcut (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq [.object.sha, .object.type] | @tsv "prettier" --write '../../../**/*.json' '!../../../pkg/workflow/js/**/*.json' --ignore-path ../.grep infocmp /opt/hostedtoolcache/node/24.14.1/x64/bin/node w/js/**/*.json' /usr/libexec/docker/cli-plugins/docker-compose ache/go/1.25.8/xdocker-cli-plugin-metadata /usr/bin/gh node /tmp�� runs/20260513-094509-25054/test-1941664494 sOverlay,MediaRoc /usr/bin/git url --jq /usr/bin/infocmp/tmp/gh-aw/aw-feature-branch.patch git (http block)
  • https://api.github.com/repos/actions/github-script/git/ref/tags/v9
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq [.object.sha, .object.type] | @tsv (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq [.object.sha, .object.type] | @tsv th .prettierignore --log-level=e!../../../pkg/workflow/js/**/*.json (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq [.object.sha, .object.type] | @tsv th .prettierigno-errorsas (http block)
  • https://api.github.com/repos/actions/github-script/git/ref/tags/v9.0.0
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9.0.0 --jq [.object.sha, .object.type] | @tsv (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9.0.0 --jq [.object.sha, .object.type] | @tsv -c=4 -nolocalimports -importcfg /tmp/go-build3978635608/b391/importcfg -pack /home/REDACTED/work/gh-aw/gh-aw/internal/tools/actions-build/main.go (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9.0.0 --jq [.object.sha, .object.type] | @tsv go1.25.8 -c=4 -nolocalimports -importcfg /tmp/go-build3978635608/b400/importcfg -pack /tmp/go-build3978635608/b400/_testmain.go ode_�� (http block)
  • https://api.github.com/repos/actions/setup-go/git/ref/tags/v4
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv /ref/tags/v9.0.0 /tmp/go-build3978635608/b144/vet.cfg sv (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv 444564643 git ache/node/24.14.-f /../../.prettierinfocmp 2c9b4f1b..HEAD (http block)
  • https://api.github.com/repos/actions/setup-node/git/ref/tags/v4
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv --write **/*.cjs 64/pkg/tool/linux_amd64/compile **/*.json --ignore-path ../../../.pretti(create|run) 64/pkg/tool/linux_amd64/compile -c g_.a (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv 4152-15063/test-3995600344/.github/workflows -buildtags (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv bility_SameInputSameOutput312220-f -trimpath /usr/bin/git -p github.com/githu-1 -lang=go1.25 git -C UpdateDiscussionFieldEnforcement3881106610/001 show /usr/bin/git url -nolocalimports -importcfg git (http block)
  • https://api.github.com/repos/actions/setup-node/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv 3881106610/001 8635608/b117/vet.cfg g_.a (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv sRemoteWithRealGitmain_branch1777664892/001 sRemoteWithRealGitmain_branch1777664892/002/work .cfg (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv Yh2vLBL1s (http block)
  • https://api.github.com/repos/actions/upload-artifact/git/ref/tags/v4
    • Triggering command: /usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv 2lbyJ7o_x 8635608/b088/vet.cfg ser.test (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv ithout_min-integrity13526/001 /usr/lib/git-cor--jq son ignore l /usr/bin/git node /opt�� rite '**/*.cjs' '**/*.ts' '**/*.json' --ignore-path ../../../.pr**/*.json --write bin/sh **/*.ts **/*.json --ignore-path node (http block)
  • https://api.github.com/repos/aws-actions/configure-aws-credentials/git/ref/tags/v4
    • Triggering command: /usr/bin/gh gh api /repos/aws-actions/configure-aws-credentials/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv -bool 8635608/b444/_testmain.go (http block)
    • Triggering command: /usr/bin/gh gh api /repos/aws-actions/configure-aws-credentials/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv -bool -buildtags /usr/bin/git -errorsas -ifaceassert -nilfunc git ls-r�� --symref origin (http block)
    • Triggering command: /usr/bin/gh gh api /repos/aws-actions/configure-aws-credentials/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv 37 infocmp ion.lock.yml re --log-level=einfocmp nly /usr/bin/infocmpxterm-color /opt/hostedtoolcache/go/1.25.8/x--jq -ato�� -instructions-test-2094596373/.github/workflows -buildtags (http block)
  • https://api.github.com/repos/azure/login/git/ref/tags/v2
    • Triggering command: /usr/bin/gh gh api /repos/azure/login/git/ref/tags/v2 --jq [.object.sha, .object.type] | @tsv tructions-test-4068173166 -trimpath (http block)
    • Triggering command: /usr/bin/gh gh api /repos/azure/login/git/ref/tags/v2 --jq [.object.sha, .object.type] | @tsv runs/20260513-094509-25054/test-2625008085/.github/workflows --write /opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linux_amd64/vet !../../../pkg/wonode --ignore-path ../../../.prettiinstall /opt/hostedtoolc--package-lock-only -ato�� ithub-script/git/ref/tags/v9 -buildtags bject.type] | @tsv -errorsas -ifaceassert -nilfunc git (http block)
  • https://api.github.com/repos/docker/login-action/git/ref/tags/v3
    • Triggering command: /usr/bin/gh gh api /repos/docker/login-action/git/ref/tags/v3 --jq [.object.sha, .object.type] | @tsv tructions-test-4068173166/.github/workflows -test.v=true /usr/bin/git l -test.run=^Test -test.short=trueinstall git comm�� -m l /usr/bin/git (http block)
    • Triggering command: /usr/bin/gh gh api /repos/docker/login-action/git/ref/tags/v3 --jq [.object.sha, .object.type] | @tsv runs/20260513-094509-25054/test-2625008085/.github/workflows --write (http block)
  • https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v0.1.2
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v0.1.2 --jq [.object.sha, .object.type] | @tsv -unreachable=false /tmp/go-build3978635608/b063/vet.cfg 1/x64/bin/node (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v0.1.2 --jq [.object.sha, .object.type] | @tsv ApprovalLabelsCompiledOutput573501635/001 on .cfg /../../.prettierinfocmp erignore bject.type] | @txterm-color sh -c 4509-25054/test-3051444897/.github/workflows infocmp /usr/local/.ghcup/bin/sh ithub-script/gitinfocmp 64/pkg/tool/linu-1 bject.type] | @txterm-color sh (http block)
  • https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v1.0.0
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v1.0.0 --jq [.object.sha, .object.type] | @tsv avZU2Szqb **/*.cjs 1/x64/bin/node **/*.json --ignore-path ../../../.pretti/tmp/gh-aw-test-runs/20260513-094152-15063/test-1927610040 ache/go/1.25.8/xconfig -has�� (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v1.0.0 --jq [.object.sha, .object.type] | @tsv /workflows /.config/google-100 k/gh-aw/gh-aw/ac--created nnel= -release=Ubuntu init t=Linux d=Chrome_Linux =147�� te '**/*.cjs' '**/*.ts' '**/*.json' --ignore-path ../../../.prettierignore connection .cfg 2 test@example.comsecret 64/bin/node npx (http block)
  • https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v1.2.3
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v1.2.3 --jq [.object.sha, .object.type] | @tsv wS9XglYEC 8635608/b083/vet.cfg 64/pkg/tool/linux_amd64/link (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v1.2.3 --jq [.object.sha, .object.type] | @tsv rity1954639348/001 origin k/node_modules/.bin/node ./../.prettieriggit -1 sv sh ache�� 2571613744 git ache/node/24.14.1/x64/bin/node user.name Test User (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs
    • Triggering command: /usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --limit 100 --created >=2026-05-06 (http block)
    • Triggering command: /usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --limit 100 --created >=2026-04-13 (http block)
    • Triggering command: /usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --limit 100 --created >=2026-02-12 (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/1/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/1/artifacts --jq .artifacts[].name .cfg 64/pkg/tool/linux_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh run download 1 --dir test-logs/run-1 LsRemoteWithRealGitmain_branch1777664892/001' x_amd64/compile (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/1/artifacts --jq .artifacts[].name --jq /home/REDACTED/work/_temp/uv-python-dir/sh /ref/tags/v9 r sv sh -c y_with_repos=public_1397292747/0remote.upstream.url /opt/hostedtoolcache/node/24.14.1/x64/bin/node 1/x64/bin/node /../../.prettiergit /tmp/go-build397remote sv sh (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/12345/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/12345/artifacts --jq .artifacts[].name .cfg 64/pkg/tool/linux_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh run download 12345 --dir test-logs/run-12345 .cfg 64/pkg/tool/linux_amd64/vet ata/action_pins.git (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/12345/artifacts --jq .artifacts[].name --jq h /ref/tags/v9 x_amd64/vet sv git k/gh�� *.json' '!../../../pkg/workflow/js/**/*.json' --ignore-path ../../../.prettierignore on ache/go/1.25.8/x64/pkg/tool/linux_amd64/compile /../../.prettiergit erignore (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/1234567890
    • Triggering command: /usr/bin/gh gh api repos/{owner}/{repo}/actions/runs/1234567890 --jq {databaseId: .id, number: .run_number, url: .html_url, status: .status, conclusion: .conclusion, workflowName: .name, workflowPath: .path, createdAt: .created_at, startedAt: .run_started_at, updatedAt: .updated_at, event: .event, headBranch: .head_branch, on' --ignore-patgo1.25.8 rk nfig/composer/ve-nolocalimports (http block)
    • Triggering command: /usr/bin/gh gh api repos/{owner}/{repo}/actions/runs/1234567890 --jq {databaseId: .id, number: .run_number, url: .html_url, status: .status, conclusion: .conclusion, workflowName: .name, workflowPath: .path, createdAt: .created_at, startedAt: .run_started_at, updatedAt: .updated_at, event: .event, headBranch: .head_branch, h ../../../.pret.prettierignore ache/go/1.25.8/x--log-level=error odules/npm/node_modules/@npmcli/run-script/lib/node-gyp-bin/sh 4152-15063/test-/opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linux_amd64/compile /tmp/go-build397-V=full /opt/hostedtoolcache/go/1.25.8/x--noprofile git diff�� w/js/**/*.json' --ignore-path ../../../.prettierignore b9ed7ddf95ff95427b56c66d8e86a8252c9b4f1b..HEAD bject.type] | @tsv 425993921/001 /tmp/go-build397/tmp/js-hash-test-1707027741/test-hash.js 8635608/b440/vet/tmp/TestHashStability_SameInputSameOutput252918260/001/stability-test.md infocmp (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/12346/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/12346/artifacts --jq .artifacts[].name user.email 64/pkg/tool/linux_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh run download 12346 --dir test-logs/run-12346 user.name 64/pkg/tool/linu-nolocalimports workflow/data/ac/usr/lib/git-core/git (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/12346/artifacts --jq .artifacts[].name git k/node_modules/.bin/node (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/2/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/2/artifacts --jq .artifacts[].name .cfg 64/pkg/tool/linux_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh run download 2 --dir test-logs/run-2 itmaster_branch3-c=4 x_amd64/link (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/2/artifacts --jq .artifacts[].name --jq tions/setup/js/node_modules/.bin/prettier /ref/tags/v9 r sv teProvider,Globaorigin -c y_with_repos_array_c3642559313/001 son k/gh-aw/gh-aw/actions/node_modules/.bin/sh /../../.prettiergit x_amd64/vet sv npx (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/3/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/3/artifacts --jq .artifacts[].name .cfg x_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh run download 3 --dir test-logs/run-3 .cfg 64/pkg/tool/linux_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/3/artifacts --jq .artifacts[].name infocmp /opt/hostedtoolcache/uv/0.11.14/x86_64/sh xterm-color r /usr/bin/git sh -c *.json' '!../../../pkg/workflow/remote.origin.url git k/gh-aw/gh-aw/actions/setup/node_modules/.bin/sh /../../.prettiergit resolved$ /usr/bin/git sh (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/4/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/4/artifacts --jq .artifacts[].name .cfg 64/pkg/tool/linux_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh run download 4 --dir test-logs/run-4 .cfg 64/pkg/tool/linux_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/4/artifacts --jq .artifacts[].name node tions/setup/js/node_modules/.bin/node /home/REDACTED/worgit r (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/5/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/5/artifacts --jq .artifacts[].name user.name 64/pkg/tool/linux_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh run download 5 --dir test-logs/run-5 .cfg x_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/5/artifacts --jq .artifacts[].name --jq tions/setup/js/node_modules/.bin/node /ref/tags/v9 r sv sh tion�� y_with_repos_array_c3642559313/001 /usr/bin/unpigz 1/x64/bin/node ignore url sv node (http block)
  • https://api.github.com/repos/github/gh-aw/actions/workflows
    • Triggering command: /usr/bin/gh gh workflow list --json name,state,path on' --ignore-path ../../../.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --workflow nonexistent-workflow-12345 --limit 100 (http block)
    • Triggering command: /usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --workflow nonexistent-workflow-12345 --limit 6 (http block)
  • https://api.github.com/repos/github/gh-aw/contents/.github/workflows/shared/reporting.md
    • Triggering command: /tmp/go-build3978635608/b405/cli.test /tmp/go-build3978635608/b405/cli.test -test.testlogfile=/tmp/go-build3978635608/b405/testlog.txt -test.paniconexit0 -test.v=true -test.parallel=4 -test.timeout=10m0s -test.run=^Test -test.short=true (http block)
    • Triggering command: /tmp/go-build3947256773/b405/cli.test /tmp/go-build3947256773/b405/cli.test -test.testlogfile=/tmp/go-build3947256773/b405/testlog.txt -test.paniconexit0 -test.v=true -test.parallel=4 -test.timeout=10m0s -test.run=^Test -test.short=true (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v0.47.4
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v0.47.4 --jq [.object.sha, .object.type] | @tsv runs/20260513-094152-15063/test-2423792551 --jq /usr/lib/git-core/git url (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v0.47.4 --jq [.object.sha, .object.type] | @tsv licyMinIntegrityOnlyCompiledOutput1677572189/001 ../../../**/*.json /usr/bin/git l ../../../.pretti\n /usr/bin/gh git -C /tmp/gh-aw-test-runs/20260513-094509-25054/test-add-source-path-2023879269/.github/workflows url /usr/bin/git remote.origin.ursh --jq bject.type] | @techo 'not found' >&2; exit 1 git (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v1.0.0
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v1.0.0 --jq [.object.sha, .object.type] | @tsv te '../../../**/*.json' '!../../go1.25.8 dbox_agent_disabled_test.go 64/pkg/tool/linux_amd64/link (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v1.0.0 --jq [.object.sha, .object.type] | @tsv re --log-level=e!../../../pkg/workflow/js/**/*.json L7andYuWnMsHU/Cg--ignore-path x86_64/sh ry=1 -buildtags ache/go/1.25.8/x/tmp/gh-aw-test-runs/20260513-094509-25054/test-source-field-variant-2070905169 head -500�� js/**/*.json' --ignore-path ../../../.prettierignore ache/go/1.25.8/x--jq _modules/.bin/sh -bool -buildtags ache/go/1.25.8/x--all-progress-implied infocmp (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v1.2.3
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v1.2.3 --jq [.object.sha, .object.type] | @tsv iant-4102690943 ame x_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v1.2.3 --jq [.object.sha, .object.type] | @tsv '**/*.ts' '**/*.json' --ignore-path ../../../.pr**/*.json /opt/hostedtoolc--jq go _test.go -buildtags ache/node/24.14./tmp/gh-aw-test-runs/20260513-094509-25054/test-2625008085/.github/workflows infocmp -1 request_test.go /usr/lib/git-cor--jq ules/.bin/node k/gh-aw/gh-aw/.ginfocmp --stdin ache/node/24.14.xterm-color infocmp (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v2.0.0
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v2.0.0 --jq [.object.sha, .object.type] | @tsv '**/*.ts' '**/*.go1.25.8 ame x_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v2.0.0 --jq [.object.sha, .object.type] | @tsv go1.25.8 -c=4 -nolocalimports -importcfg /tmp/go-build3978635608/b465/importcfg -pack /tmp/go-build3978635608/b465/_testmain.go conf�� .js' --ignore-paremote.origin.url --local x_amd64/vet http.https://gitinfocmp (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v2.0.0 --jq [.object.sha, .object.type] | @tsv '**/*.ts' '**/*.json' --ignore-p-errorsas r x_amd64/vet (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v3.0.0
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v3.0.0 --jq [.object.sha, .object.type] | @tsv '**/*.ts' '**/*.json' --ignore-path ../../../.pr**/*.json ame x_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v3.0.0 --jq [.object.sha, .object.type] | @tsv '**/*.ts' '**/*.json' --ignore-path ../../../.pr**/*.json --jq bin/node 8635608/b465/ttygit -tests ache/node/24.14./tmp/gh-aw-test-runs/20260513-094509-25054/test-583413625/.github/workflows gh 8d51�� th .prettierignoremote.origin.url --jq x86_64/node k/gh-aw/gh-aw/.g/opt/hostedtoolcache/node/24.14.1/x64/bin/node /tmp/TestParseDe/tmp/test-expr-1283268529.js t gh (http block)
  • https://api.github.com/repos/github/gh-aw/issues/17
    • Triggering command: /usr/bin/gh gh api repos/github/gh-aw/issues/17 -extld=gcc /tmp/go-build3978635608/b441/_pkg_.a on' --ignore-path ../../../.pret.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api repos/github/gh-aw/issues/17 infocmp ode_�� h ../../../.pret.prettierignore /opt/hostedtoolc--log-level=error sh /ref/tags/v9 /tmp/go-build397/home/REDACTED/work/gh-aw/gh-aw/actions/setup/js/node_modules/.bin/pre�� 1/x64/bin/node git stat�� w/js/**/*.json' --ignore-path 1/x64/bin/node bject.type] | @tsv g/testutil/spec_git g/testutil/tempd-C ache/go/1.25.8/x/tmp/gh-aw-add-gitattributes-test44667478/.github/workflows infocmp (http block)
  • https://api.github.com/repos/google-github-actions/auth/git/ref/tags/v2
    • Triggering command: /usr/bin/gh gh api /repos/google-github-actions/auth/git/ref/tags/v2 --jq [.object.sha, .object.type] | @tsv -bool l ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet -errorsas -ifaceassert -nilfunc ache/go/1.25.8/x--package-lock-only (http block)
    • Triggering command: /usr/bin/gh gh api /repos/google-github-actions/auth/git/ref/tags/v2 --jq [.object.sha, .object.type] | @tsv ithub-script/git/ref/tags/v9 infocmp ache/node/24.14.1/x64/bin/node re --log-level=enode ache/go/1.25.8/x/opt/hostedtoolcache/node/24.14.1/x64/bin/npm /node ache/node/24.14.--package-lock-only 3882�� 690/001 -buildtags /usr/lib/git-core/git -errorsas -ifaceassert -nilfunc /usr/lib/git-core/git (http block)
  • https://api.github.com/repos/nonexistent/action/git/ref/tags/v999.999.999
    • Triggering command: /usr/bin/gh gh api /repos/nonexistent/action/git/ref/tags/v999.999.999 --jq [.object.sha, .object.type] | @tsv te '../../../**/*.json' '!../../-errorsas --auto $name) { hasDiscussionsEnabled } } --detach (http block)
    • Triggering command: /usr/bin/gh gh api /repos/nonexistent/action/git/ref/tags/v999.999.999 --jq [.object.sha, .object.type] | @tsv re --log-level=error e/git bject.type] | @tsv -bool -buildtags Name,createdAt,s-bool bash /pre�� submodules | hea-errorsas 8635608/b450/sta-ifaceassert odules/npm/node_-nilfunc t0 -buildtags (http block)
  • https://api.github.com/repos/nonexistent/repo/actions/runs/12345
    • Triggering command: /usr/bin/gh gh run view 12345 --repo nonexistent/repo --json status,conclusion (http block)
    • Triggering command: /usr/bin/gh gh run view 12345 --repo nonexistent/repo --json status,conclusion /tmp/TestCompileinfocmp resolved$ /usr/bin/git git -c log.showsignature=false log /home/REDACTED/work/gh-aw/gh-aw/node_modules/.bin/node nore x_amd64/vet /usr/bin/git node (http block)
  • https://api.github.com/repos/org/repo/pulls/1
    • Triggering command: /usr/bin/gh gh api repos/org/repo/pulls/1 -tests /tmp/go-build3978635608/b435/vet.cfg on' --ignore-path ../../../.pret.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api repos/org/repo/pulls/1 gh ode_�� h ../../../.prettierignore --jq sv 4152-15063/test-node -buildtags xpires.lock.yml /usr/lib/git-cor../../../**/*.json main�� w/js/**/*.json' --ignore-path --auto (http block)
  • https://api.github.com/repos/owner/repo/actions/secrets
    • Triggering command: /usr/bin/gh gh api /repos/owner/repo/actions/secrets --jq .secrets[].name on' --ignore-path ../../../.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api /repos/owner/repo/actions/secrets --jq .secrets[].name on' --ignore-path ../../../.prettierignore --jq sv 4152-15063/test-sh -trimpath Name,createdAt,s"prettier" --write '../../../**/*.json' '!../../../pkg/workflow/js/**/*.json' ---test.timeout=10m0s gh er ./../pkg/workflow/js/**/*.json' --ignore-path --jq sv -unreachable=falnode /tmp/go-build397/tmp/js-hash-test-3501360722/test-hash.js /opt/hostedtoolc/tmp/TestHashConsistency_GoAndJavaScript857689514/001/test-frontmatter-with-env-template-expressions.md gh (http block)
  • https://api.github.com/repos/owner/repo/actions/workflows
    • Triggering command: /usr/bin/gh gh workflow list --json name,state,path --repo owner/repo rgo/bin/git (http block)
    • Triggering command: /usr/bin/gh gh workflow list --json name,state,path --repo owner/repo p/bin/git (http block)
    • Triggering command: /usr/bin/gh gh workflow list --repo owner/repo --json name,path,state 64/pkg/tool/linux_amd64/vet (http block)
  • https://api.github.com/repos/test-owner/test-repo/actions/secrets
    • Triggering command: /usr/bin/gh gh api /repos/test-owner/test-repo/actions/secrets --jq .secrets[].name on' --ignore-path ../../../.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api /repos/test-owner/test-repo/actions/secrets --jq .secrets[].name 92569138/001' 92569138/001' sv -unreachable=falsh /tmp/go-build397-c (http block)
  • https://api.github.com/repos/test/repo
    • Triggering command: /usr/bin/gh gh api /repos/test/repo --jq .default_branch te '../../../**/*.json' '!../../-p main .cfg (http block)
    • Triggering command: /usr/bin/gh gh api /repos/test/repo --jq .default_branch (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Agent-Logs-Url: https://github.com/github/gh-aw/sessions/b131c6fe-3758-40a4-b6b9-f14dbcb00481

Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot AI changed the title [WIP] Convert 'Getting Help' run-on sentence to numbered list Docs UX: Convert “Getting Help” run-on guidance into prioritized numbered steps May 13, 2026
Copilot AI requested a review from gh-aw-bot May 13, 2026 09:47
@pelikhan

Copy link
Copy Markdown
Collaborator

@copilot suggest to use an agent and debug.md

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI commented May 13, 2026

Copy link
Copy Markdown
Contributor Author

@copilot suggest to use an agent and debug.md

Updated in commit c392cd9.

I added a new prioritized Getting Help step to use an agent with the debug.md prompt, and adjusted the examples link to a valid docs route.

Copilot AI requested a review from pelikhan May 13, 2026 09:59
@pelikhan
pelikhan marked this pull request as ready for review May 13, 2026 10:04
Copilot AI review requested due to automatic review settings May 13, 2026 10:04

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Improves the Troubleshooting “Getting Help” section by converting dense guidance into a scan-friendly, prioritized set of numbered actions to follow when an error isn’t documented.

Changes:

  • Replaced a single run-on paragraph with an ordered checklist of actions.
  • Prioritized running gh aw compile --verbose first to surface more diagnostic output.
  • Updated/expanded help paths with direct links (debug prompt, examples, Common Issues, GitHub issues).
Show a summary per file
File Description
docs/src/content/docs/troubleshooting/errors.md Rewrites “Getting Help” guidance into a numbered, prioritized flow with clearer, more actionable steps and updated links.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 1

Comment on lines +362 to +367
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
@pelikhan
pelikhan merged commit 356b6e4 into main May 13, 2026
4 checks passed
@pelikhan
pelikhan deleted the copilot/fix-getting-help-ux branch May 13, 2026 10:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

4 participants