Skip to content

Commit 33a0577

Browse files
docs: reduce bloat in custom-agent-for-aw reference page (#24223)
1 parent c0865b8 commit 33a0577

1 file changed

Lines changed: 5 additions & 47 deletions

File tree

docs/src/content/docs/reference/custom-agent-for-aw.mdx

Lines changed: 5 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,13 @@ Follow these steps to set up your repository for agentic workflows using the cus
2727
Initialize this repository for GitHub Agentic Workflows using https://github.com/github/gh-aw/blob/main/install.md
2828
```
2929

30-
This will guide your coding agent to:
31-
- Install the `gh-aw` CLI extension
32-
- Run `gh aw init` to create necessary configuration files
33-
- Commit and push the changes, or create a pull request
34-
3530
Alternatively just run
3631

3732
```bash
3833
gh aw init
3934
```
4035

41-
After initialization, you'll have:
42-
- `.github/agents/agentic-workflows.agent.md` - [A Copilot file](/gh-aw/reference/glossary/#agent-files) (custom AI instructions) for the `/agent agentic-workflows` command in Copilot Chat
43-
- Additional configuration files for workflow authoring
36+
After initialization, you'll have `.github/agents/agentic-workflows.agent.md`, a [Copilot agent file](/gh-aw/reference/glossary/#agent-files) that registers the `/agent agentic-workflows` command in Copilot Chat.
4437

4538
## Using the Copilot Agent Files for Agentic Workflows
4639

@@ -82,14 +75,10 @@ Import workflows from any accessible GitHub repository:
8275
/agent agentic-workflows import workflow from https://github.com/githubnext/agentics/blob/main/workflows/ci-doctor.md
8376
```
8477

85-
When importing, you can specify customizations:
78+
When importing, you can specify customizations such as engine or tools:
8679

8780
```text wrap
88-
# Import and change engine
8981
/agent agentic-workflows import issue-triage from githubnext/agentics and use claude engine
90-
91-
# Import and add tools
92-
/agent agentic-workflows import pr-review from owner/repo and add web-fetch tool
9382
```
9483

9584
### Debugging Agentic Workflows
@@ -100,40 +89,13 @@ When workflows fail or behave unexpectedly, use the agentic-workflows agent to i
10089
/agent agentic-workflows debug why is my issue-triage workflow failing?
10190
```
10291

103-
You can investigate a specific workflow run using its ID or URL:
92+
For the fastest diagnosis, pass the full run URL from the GitHub Actions page:
10493

10594
```text wrap
106-
# Debug by run ID
107-
/agent agentic-workflows debug run 1234567890
108-
109-
# Debug from GitHub Actions URL
110-
/agent agentic-workflows debug https://github.com/owner/repo/actions/runs/1234567890
95+
/agent agentic-workflows debug https://github.com/OWNER/REPO/actions/runs/RUN_ID
11196
```
11297

113-
> [!TIP]
114-
> For the fastest diagnosis, give the agent the full run URL from the GitHub Actions page:
115-
>
116-
> ```text wrap
117-
> /agent agentic-workflows debug https://github.com/OWNER/REPO/actions/runs/RUN_ID
118-
> ```
119-
>
120-
> Replace `OWNER`, `REPO`, and `RUN_ID` with your values. The agent will audit logs, identify the root cause, and suggest targeted fixes.
121-
122-
The agent can help with various debugging scenarios:
123-
124-
```text wrap
125-
# Permission errors
126-
/agent agentic-workflows debug getting 403 errors in my workflow
127-
128-
# Missing tools
129-
/agent agentic-workflows debug workflow says tool not found
130-
131-
# Network access issues
132-
/agent agentic-workflows debug workflow cannot access external API
133-
134-
# Safe-output problems
135-
/agent agentic-workflows debug agent output not creating issues
136-
```
98+
The agent audits logs, identifies the root cause, and suggests targeted fixes. It handles permission errors, missing tools, network access issues, and safe-output problems — just describe the issue in natural language.
13799

138100
### Self-Contained Debugging (Without Copilot)
139101

@@ -149,10 +111,6 @@ The failed workflow run is at https://github.com/OWNER/REPO/actions/runs/RUN_ID
149111

150112
The `debug.md` file is a self-contained prompt that works with any coding agent or AI assistant. It guides the agent to install `gh aw`, analyze the run logs, identify the root cause, and open a pull request with the fix.
151113

152-
## Other Agents and Chats
153-
154-
The agent file can be loaded into other AI chat interfaces that support custom instructions. The agent is designed to be compatible with various AI tools, although some features might require configuration and you'll need to allow running the compiler.
155-
156114
## Creating Agentic Workflows with an AI Chatbot
157115

158116
If you prefer to use an AI chatbot to author agentic workflows, use the [agentic-chat instructions](https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/agentic-chat.md) with any conversational AI application. <CopyEntireFileButton filePath="https://raw.githubusercontent.com/github/gh-aw/main/.github/aw/agentic-chat.md" label="Copy agentic-chat instructions" />

0 commit comments

Comments
 (0)