Skip to content

Commit 1919d43

Browse files
workshop docs: add gh-aw doc links to side-quest files (#1891)
1 parent 8aa6666 commit 1919d43

8 files changed

Lines changed: 8 additions & 8 deletions

β€Žworkshop/side-quest-09-01f-debugging-checklist.mdβ€Ž

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

2626
- [ ] I can run this checklist in order without skipping steps
2727
- [ ] I know where to find both live logs and safe-output records
28-
- [ ] I can decide whether the root cause is prompt, data, permissions, or output limits
28+
- [ ] I can decide whether the root cause is prompt, data, [permissions](https://github.github.com/gh-aw/reference/permissions/), or output limits
2929
- [ ] I can gather a minimal log snippet to share for deeper diagnosis
3030

3131
<!-- /journey -->

β€Žworkshop/side-quest-10-01-agent-brief.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Quick check:
7373
<details>
7474
<summary>Why this works</summary>
7575

76-
Inputs turn "summarize the repo" into a concrete data request. They also make it easier to spot missing permissions or tools when you build the workflow.
76+
Inputs turn "summarize the repo" into a concrete data request. They also make it easier to spot missing [permissions](https://github.github.com/gh-aw/reference/permissions/) or tools when you build the workflow.
7777

7878
</details>
7979

β€Žworkshop/side-quest-10-02-jailbreak-brief.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ gh-aw uses five defence layers. Here is the short version, in three groups:
4040

4141
- **Compiled task brief** β€” The task brief is baked in before any data arrives. Issue bodies and PR descriptions reach the agent as structured tool call results, competing with an authoritative baseline rather than replacing it.
4242
- **Minimal `permissions:` + `safe-outputs`** β€” The `GITHUB_TOKEN` enforces declared permission boundaries; `safe-outputs` removes write tool paths that were never declared, so a jailbreak instruction to push a commit has no execution path.
43-
- **`network.allowed-domains` + agentic threat detection** β€” The network layer blocks data exfiltration to unlisted endpoints; a separate detection job reviews agent output in an isolated sandbox before any write lands.
43+
- **`network.allowed-domains` + [agentic threat detection](https://github.github.com/gh-aw/reference/threat-detection/)** β€” The network layer blocks data exfiltration to unlisted endpoints; a separate detection job reviews agent output in an isolated sandbox before any write lands.
4444

4545
<details>
4646
<summary>Detailed breakdown of each layer</summary>

β€Žworkshop/side-quest-11-01b-workflow-structure.mdβ€Ž

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

1313
An [agentic workflow](https://github.github.com/gh-aw/introduction/overview/) file has two parts:
1414

15-
- **Frontmatter** β€” YAML between `---` fences at the top of the file. This configures how and when the workflow runs.
15+
- **[Frontmatter](https://github.github.com/gh-aw/reference/frontmatter/)** β€” YAML between `---` fences at the top of the file. This configures how and when the workflow runs.
1616
- **Markdown body** β€” the agent's task brief, written below the closing `---`. The AI reads this at runtime.
1717

1818
The file ends in `.md` instead of `.yml` because the frontmatter is only the opening config block β€” the rest of the file is a Markdown brief that the agent reads at runtime. See the [Classic vs. Agentic comparison in Step 5](05-agentic-workflows-intro.md).

β€Žworkshop/side-quest-11-02-yaml-frontmatter.mdβ€Ž

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

55
> _Optional: work through these common YAML mistakes if you hit a compile error in Step 11, then return to the main path._
66
7-
YAML is unforgiving. Here are the five errors learners hit most often when building agentic workflow frontmatter, each with a broken ❌ and correct βœ… example.
7+
YAML is unforgiving. Here are the five errors learners hit most often when building agentic workflow [frontmatter](https://github.github.com/gh-aw/reference/frontmatter/), each with a broken ❌ and correct βœ… example.
88

99
---
1010

β€Žworkshop/side-quest-11-03-better-prompts.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- page-adventure: side-quest -->
33
# Side Quest: Write Better AI Task Briefs
44

5-
> _Optional: work through this guide if you want to get more useful, consistent output from your agentic workflows β€” then return to [Step 11](07-your-first-workflow.md) or [Step 12](12-test-and-iterate.md)._
5+
> _Optional: work through this guide if you want to get more useful, consistent output from your [agentic workflows](https://github.github.com/gh-aw/introduction/overview/) β€” then return to [Step 11](07-your-first-workflow.md) or [Step 12](12-test-and-iterate.md)._
66
77
## 🎯 What You'll Do
88

β€Žworkshop/side-quest-11-04-annotated-workflow.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Understand the four design decisions that make `daily-status.md` safe and predic
2020
| Decision | What it controls |
2121
|---------|-----------------|
2222
| Narrow `permissions` | Only the scopes the workflow actually needs β€” limits blast radius |
23-
| `gh-proxy` in `tools` | Enforces permissions at the [network](https://github.github.com/gh-aw/reference/network/) level |
23+
| `gh-proxy` in `tools` | Enforces [permissions](https://github.github.com/gh-aw/reference/permissions/) at the [network](https://github.github.com/gh-aw/reference/network/) level |
2424
| `max: 1` in `safe-outputs` | Caps writes to exactly one comment per run |
2525
| Fixed output template | Same format every run β€” easy to scan and audit |
2626

β€Žworkshop/side-quest-11-05-event-triggers.mdβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<!-- page-adventure: side-quest -->
33
# Side Quest: Event-Driven Triggers in Agentic Workflows
44

5-
> _Optional: use this primer if you want help choosing between scheduled and event-driven workflows before you finish [Build β€” PR Code Reviewer](15-conditional-logic.md), then return to the main adventure._
5+
> _Optional: use this primer if you want help choosing between [scheduled](https://github.github.com/gh-aw/reference/triggers/#scheduled-triggers-schedule) and event-driven workflows before you finish [Build β€” PR Code Reviewer](15-conditional-logic.md), then return to the main adventure._
66
77
## 🎯 What You'll Do
88

0 commit comments

Comments
Β (0)