Skip to content

Commit 4fc31e7

Browse files
workshop docs: add gh-aw doc links (#3434)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 3cb0cda commit 4fc31e7

8 files changed

Lines changed: 9 additions & 9 deletions

‎workshop/side-quest-07d-billing-paths.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ If you see `401 Unauthorized` in the run log, see [Method 1: Copilot Requests Pe
5050
Use this path for a personal repository, or when the owning organization does not provide centralized Copilot billing.
5151

5252
> [!IMPORTANT]
53-
> When `copilot-requests: write` is present, the workflow ignores `COPILOT_GITHUB_TOKEN`. Remove that permission line before adding the secret.
53+
> When `copilot-requests: write` is present, the workflow ignores `COPILOT_GITHUB_TOKEN`. Remove that [permission](https://github.github.com/gh-aw/reference/permissions/#special-permission-copilot-requests-write) line before adding the secret.
5454
5555
1. Open `daily-report-status.md` and remove `copilot-requests: write`.
5656
2. Generate a fine-grained PAT with **Copilot requests: Read-only** at [github.com/settings/tokens](https://github.com/settings/tokens).

‎workshop/side-quest-08-01-codespaces-actions-write.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
This side quest applies to you if **both** of the following are true:
1010

1111
- You are running `gh aw run` inside a GitHub Codespace (not a local environment).
12-
- You see an `actions:write` permission error (HTTP 403) in your terminal run log.
12+
- You see an `actions:write` [permission](https://github.github.com/gh-aw/reference/permissions/) error (HTTP 403) in your terminal run log.
1313

1414
If you are not in a Codespace or you do not see the 403 error, return to [Run and Watch Your Workflow](08-run-your-workflow.md) and use the GitHub Actions UI path instead.
1515

‎workshop/side-quest-09-01-debug-output.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ You will diagnose five common output patterns one at a time. Each micro-step inc
1616

1717
| Pattern | What you learn | Micro-step |
1818
|---|---|---|
19-
| Long `[plan]` chain | How to turn planning loops into concrete tool calls | [09-01a](side-quest-09-01a-pattern-long-plan-chain.md) |
20-
| Empty tool results | How to separate permission issues from filter issues | [09-01b](side-quest-09-01b-pattern-empty-results.md) |
19+
| Long `[plan]` chain | How to turn planning loops into concrete [tool](https://github.github.com/gh-aw/reference/tools/) calls | [09-01a](side-quest-09-01a-pattern-long-plan-chain.md) |
20+
| Empty tool results | How to separate [permission](https://github.github.com/gh-aw/reference/permissions/) issues from filter issues | [09-01b](side-quest-09-01b-pattern-empty-results.md) |
2121
| [Safe-output](https://github.github.com/gh-aw/reference/safe-outputs/) `limit reached` | How to decide between raising `max` and tightening guidance | [09-01c](side-quest-09-01c-pattern-safe-output-blocked.md) |
2222
| `permission denied` | How to map failures to [`permissions`](https://github.github.com/gh-aw/reference/permissions/) vs [`safe-outputs`](https://github.github.com/gh-aw/reference/safe-outputs/) | [09-01d](side-quest-09-01d-pattern-permission-denied.md) |
2323
| "Done" with no write | How to clarify write conditions and fallback behavior | [09-01e](side-quest-09-01e-pattern-done-no-write.md) |

‎workshop/side-quest-09-01a-pattern-long-plan-chain.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## :dart: What You'll Do
66

7-
You will learn how to spot a planning loop and rewrite your workflow brief so the agent starts with an explicit first tool call.
7+
You will learn how to spot a planning loop and rewrite your workflow brief so the agent starts with an explicit first [tool](https://github.github.com/gh-aw/reference/tools/) call.
88

99
## :clipboard: Before You Start
1010

‎workshop/side-quest-09-01b-pattern-empty-results.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## :dart: What You'll Do
66

7-
You will diagnose empty tool responses and decide whether the root cause is missing read scope, over-filtering, or truly empty repository data.
7+
You will diagnose empty [tool](https://github.github.com/gh-aw/reference/tools/) responses and decide whether the root cause is missing read scope, over-filtering, or truly empty repository data.
88

99
## :clipboard: Before You Start
1010

‎workshop/side-quest-09-01c-pattern-safe-output-blocked.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A safe-output error such as `E002: add-comment limit reached — 1 of 1 already
1717

1818
Treat `max` as a safety boundary, not a convenience setting. A low limit reduces accidental spam if instructions are interpreted too broadly.
1919

20-
When changing behavior, prefer precise workflow guidance like "Post one comment per run. If a comment already exists today, update context in memory and skip writing."
20+
When changing behavior, prefer precise workflow guidance like "Post one comment per run. If a comment already exists today, update context in [memory](https://github.github.com/gh-aw/patterns/memory-ops/) and skip writing."
2121

2222
If you need help with wording, ask the `agentic-workflows` skill or iterate quickly with [`gh aw compile --watch`](https://github.github.com/gh-aw/setup/cli/#compile).
2323

‎workshop/side-quest-09-01d-pattern-permission-denied.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## :dart: What You'll Do
66

7-
You will map permission failures to the correct control: read access in `permissions:` and write allowlisting in `safe-outputs:`.
7+
You will map [permission](https://github.github.com/gh-aw/reference/permissions/) failures to the correct control: read access in `permissions:` and write allowlisting in `safe-outputs:`.
88

99
## :clipboard: Before You Start
1010

‎workshop/side-quest-09-01f-debugging-checklist.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You will apply a repeatable seven-step triage flow whenever a run produces unexp
1313
## Checklist
1414

1515
1. Open the live log in **Actions** and scan for `[error]` lines first.
16-
2. Check `[plan]` density. More than four consecutive plan lines without a tool call usually means your brief is underspecified.
16+
2. Check `[plan]` density. More than four consecutive plan lines without a [tool](https://github.github.com/gh-aw/reference/tools/) call usually means your brief is underspecified.
1717
3. Inspect `[tool]` and `[result]` lines to confirm expected data is returned.
1818
4. Look for `limit reached` [safe-output](https://github.github.com/gh-aw/reference/safe-outputs/) errors, such as `E002: add-comment limit reached — 1 of 1 already used this run`, and decide whether to increase `max` or tighten "post once" guidance.
1919
5. Read the run summary and compare it to your expected write behavior.

0 commit comments

Comments
 (0)