docs: update debugging guides with copy-paste agent prompt templates#21494
Merged
docs: update debugging guides with copy-paste agent prompt templates#21494
Conversation
…plates Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update debugging guides to include agentic workflows and run url
docs: update debugging guides with copy-paste agent prompt templates
Mar 18, 2026
pelikhan
approved these changes
Mar 18, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the debugging documentation to consistently recommend using the agentic-workflows agent with a GitHub Actions run URL, and adds copy/paste-ready prompt templates and TIP callouts.
Changes:
- Expanded “How Do I Debug a Failing Workflow?” into a fuller section with Copilot Chat + self-contained templates.
- Added TIP callouts and standardized self-contained prompt wording in authoring/reference docs.
- Added two new workflow entries to the agent factory status table.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/src/content/docs/troubleshooting/common-issues.md | Adds an agent-first debugging section with copy/paste templates and a TIP callout. |
| docs/src/content/docs/guides/agentic-authoring.mdx | Adds a TIP callout and updates the self-contained debugging template wording. |
| docs/src/content/docs/reference/custom-agent-for-aw.mdx | Adds a TIP callout for run-URL usage and updates self-contained template wording. |
| docs/src/content/docs/agent-factory-status.mdx | Adds rows for “Daily Safe Output Integrator” and “Update Astro”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| ```text wrap | ||
| Debug this workflow run using https://raw.githubusercontent.com/github/gh-aw/main/debug.md | ||
|
|
||
| The failed workflow run is at https://github.com/OWNER/REPO/actions/runs/RUN_ID |
| Debug this workflow run using https://raw.githubusercontent.com/github/gh-aw/main/debug.md | ||
|
|
||
| Run URL: https://github.com/OWNER/REPO/actions/runs/RUN_ID | ||
| The failed workflow run is at https://github.com/OWNER/REPO/actions/runs/RUN_ID |
| Debug this workflow run using https://raw.githubusercontent.com/github/gh-aw/main/debug.md | ||
|
|
||
| Run URL: https://github.com/OWNER/REPO/actions/runs/RUN_ID | ||
| The failed workflow run is at https://github.com/OWNER/REPO/actions/runs/RUN_ID |
| | [Daily Project Performance Summary Generator (Using MCP Scripts)](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-performance-summary.md) | copilot | [](https://github.com/github/gh-aw/actions/workflows/daily-performance-summary.lock.yml) | - | - | | ||
| | [Daily Regulatory Report Generator](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-regulatory.md) | copilot | [](https://github.com/github/gh-aw/actions/workflows/daily-regulatory.lock.yml) | - | - | | ||
| | [Daily Rendering Scripts Verifier](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-rendering-scripts-verifier.md) | claude | [](https://github.com/github/gh-aw/actions/workflows/daily-rendering-scripts-verifier.lock.yml) | - | - | | ||
| | [Daily Safe Output Integrator](https://github.com/github/gh-aw/blob/main/.github/workflows/daily-safe-output-integrator.md) | copilot | [](https://github.com/github/gh-aw/actions/workflows/daily-safe-output-integrator.lock.yml) | - | - | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Debugging guides were sparse and inconsistent — none reliably surfaced the
agentic-workflowsagent + run URL as the primary debugging path, and none provided a ready-to-copy prompt template.Changes
troubleshooting/common-issues.mdRewrote the one-liner "How Do I Debug a Failing Workflow?" into a full section with two ready-to-copy templates and a
> [!TIP]callout:guides/agentic-authoring.mdxAdded a
> [!TIP]callout after the Copilot Chat example. Updated the self-contained prompt wording to match the issue triage template (The failed workflow run is at …instead ofRun URL: …).reference/custom-agent-for-aw.mdxAdded a
> [!TIP]callout inside "Debugging Agentic Workflows" after the run-URL examples. Applied the same self-contained prompt wording fix.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:
telemetry.astro.build/opt/hostedtoolcache/node/24.14.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.