Skip to content

Commit 431b34e

Browse files
workshop docs: add gh-aw doc links to 10 side quest files (#1909)
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 8a15d89 commit 431b34e

10 files changed

Lines changed: 11 additions & 11 deletions

workshop/side-quest-11-04-annotated-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ safe-outputs:
7474

7575
## ✏️ Your Turn — Safe-Outputs
7676

77-
1. In your `daily-status.md`, comment out the entire `safe-outputs:` block.
77+
1. In your `daily-status.md`, comment out the entire [safe-outputs](https://github.github.com/gh-aw/reference/safe-outputs/) block.
7878
2. Run `gh aw compile --validate`.
7979
3. Read the error message — what write capability does the agent lose?
8080
4. Uncomment the block and recompile to confirm the error is gone.

workshop/side-quest-11-05-event-triggers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Then:
8989

9090
## How trigger choice changes `safe-outputs`
9191

92-
The trigger decides **when** the workflow starts. The `safe-outputs` block decides **where it is allowed to write back**.
92+
The trigger decides **when** the workflow starts. The [safe-outputs](https://github.github.com/gh-aw/reference/safe-outputs/) block decides **where it is allowed to write back**.
9393

9494
| Trigger | Natural thing to reply to | Common `safe-outputs` choice |
9595
|---------|----------------------------|------------------------------|

workshop/side-quest-11-06-anthropic-key.md

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

55
> _Optional: work through this guide when you want to use [Claude](side-quest-01-02-environment-reference.md#claude) (Anthropic's model family) as the AI engine for your agentic workflow, then return to your main path._
66
7-
By default, [agentic workflows](https://github.github.com/gh-aw/introduction/overview/) run on the GitHub Copilot engine. If you prefer to use **Claude**, you'll need an Anthropic API key stored as a repository secret and a one-line change to your workflow frontmatter.
7+
By default, [agentic workflows](https://github.github.com/gh-aw/introduction/overview/) run on the [GitHub Copilot engine](https://github.github.com/gh-aw/reference/engines/). If you prefer to use **Claude**, you'll need an Anthropic API key stored as a repository secret and a one-line change to your [workflow frontmatter](https://github.github.com/gh-aw/reference/frontmatter/).
88

99
## 📋 Before You Start
1010

workshop/side-quest-11-07-openai-key.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
> _Optional: work through this guide when you want to use the `codex` engine (OpenAI-powered) for your agentic workflow, then return to your main path._
66
7-
By default, [agentic workflows](https://github.github.com/gh-aw/introduction/overview/) use the GitHub Copilot engine. To use **OpenAI models**, store an OpenAI API key as a repository secret and add one frontmatter line.
7+
By default, [agentic workflows](https://github.github.com/gh-aw/introduction/overview/) use the [GitHub Copilot engine](https://github.github.com/gh-aw/reference/engines/). To use **OpenAI models**, store an OpenAI API key as a repository secret and add one frontmatter line.
88

99
## 📋 Before You Start
1010

1111
- You have completed [Install `gh-aw`](06-install-gh-aw.md) and have a working agentic workflow.
12-
- You are familiar with YAML frontmatter `env:` blocks. If frontmatter is new, skim [Side Quest: Frontmatter Deep Dive — Part A](side-quest-11-01-frontmatter-deep-dive.md) before continuing.
12+
- You are familiar with [YAML frontmatter](https://github.github.com/gh-aw/reference/frontmatter/) `env:` blocks. If frontmatter is new, skim [Side Quest: Frontmatter Deep Dive — Part A](side-quest-11-01-frontmatter-deep-dive.md) before continuing.
1313
- You have an OpenAI account or access to an OpenAI API key from your organization.
1414

1515
> [!NOTE]

workshop/side-quest-11-08-frontmatter-tools-outputs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ safe-outputs:
6767
---
6868
```
6969

70-
**What this section does:** Closes the YAML frontmatter block. Everything below this line is the Markdown body — the agent's plain-English task brief.
70+
**What this section does:** Closes the [YAML frontmatter](https://github.github.com/gh-aw/reference/frontmatter/) block. Everything below this line is the Markdown body — the agent's plain-English task brief.
7171

7272
**✏️ Try it:** Add the closing `---` to your draft. Confirm the file now has exactly two `---` fences.
7373

workshop/side-quest-11-09-agent-session-phases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ After you submit the scenario prompt, the session shows a live activity feed. Th
2222
|---|---|---|
2323
| **Reading** | The agent fetches the `create.md` reference and reads existing files in your repository | Confirm the agent fetched the reference guide and found your repository files |
2424
| **Planning** | The agent decides what frontmatter keys, permissions, and task brief to use | The planning output should reflect your intended scenario |
25-
| **Writing** | The agent creates the workflow `.md` file in `.github/workflows/` | The file should contain a YAML frontmatter block between `---` fences and a Markdown task brief |
25+
| **Writing** | The agent creates the workflow `.md` file in `.github/workflows/` | The file should contain a [YAML frontmatter](https://github.github.com/gh-aw/reference/frontmatter/) block between `---` fences and a Markdown task brief |
2626
| **Compiling** | The agent runs `gh aw compile --validate` and fixes any errors it finds | A green success message indicates the `.lock.yml` was generated without errors |
2727
| **Opening PR** | The agent commits both files and opens a pull request | The pull request should list two changed files: the `.md` source and the `.lock.yml` |
2828

workshop/side-quest-12-01-iterate-agent-output.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Quick problem-to-fix guide:
101101
Quick run-log check:
102102

103103
- **Compile error** — run `gh aw compile` locally, or ask your Copilot agent to run it and fix the reported line.
104-
- **Missing permissions** — re-check the workflow frontmatter and confirm the safe output surface is declared correctly.
104+
- **Missing permissions** — re-check the [workflow frontmatter](https://github.github.com/gh-aw/reference/frontmatter/) and confirm the safe output surface is declared correctly.
105105
- **Rate limits or transient failures** — wait a few minutes and re-run.
106106

107107
</details>

workshop/side-quest-13-01-schedule-expressions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You'll learn how `gh-aw`'s plain-English schedule syntax maps to GitHub Actions
1818

1919
GitHub Actions stores schedules as **[cron expressions](https://github.github.com/gh-aw/reference/schedule-syntax/)** — five fields: `minute hour day-of-month month day-of-week`.
2020

21-
You do **not** need to write cron by hand for common cases. In `gh-aw`, you can write a fuzzy expression like `daily on weekdays`, then let `gh aw compile` convert it for you.
21+
You do **not** need to write cron by hand for common cases. In `gh-aw`, you can write a [fuzzy expression](https://github.github.com/gh-aw/reference/schedule-syntax/#fuzzy-schedules) like `daily on weekdays`, then let `gh aw compile` convert it for you.
2222

2323
## Fuzzy schedule reference
2424

workshop/side-quest-15-01-expressions-and-contexts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ A **context** is a named object that GitHub Actions populates automatically. The
3232
|---------|--------------|
3333
| `github` | Event metadata — repo name, branch, commit SHA, actor |
3434
| `steps.<id>.outputs` | Outputs written by a previous step using `$GITHUB_OUTPUT` |
35-
| `env` | Environment variables set in the workflow or step |
35+
| `env` | [Environment variables](https://github.github.com/gh-aw/reference/environment-variables/) set in the workflow or step |
3636
| `secrets` | Repository or organisation secrets |
3737
| `runner` | Information about the runner OS and temp directory |
3838
| `job` | Current job status |

workshop/side-quest-16-01-github-output.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
run: echo "$RESULT" # prints nothing — RESULT is gone
2020
```
2121

22-
Each step is a separate child process. Environment variables set with `export` only survive for the duration of that step.
22+
Each step is a separate child process. [Environment variables](https://github.github.com/gh-aw/reference/environment-variables/) set with `export` only survive for the duration of that step.
2323

2424
---
2525

0 commit comments

Comments
 (0)