Skip to content

Commit 683bfd8

Browse files
workshop docs: add gh-aw doc links (batch 2) (#2025)
1 parent 5b11950 commit 683bfd8

8 files changed

Lines changed: 8 additions & 8 deletions

workshop/08b-interpret-your-run.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Then verify the real output in your repository. For **Daily Report Status**, tha
5151

5252
If your run does not look right, start with these quick checks before changing the workflow:
5353

54-
- **The workflow never appears in Actions** — confirm the workflow file is committed on `main`, then refresh. If you use the terminal path, run `gh aw compile` to catch compile errors.
54+
- **The workflow never appears in Actions** — confirm the workflow file is committed on `main`, then refresh. If you use the terminal path, run `gh aw compile` to catch [compile](https://github.github.com/gh-aw/reference/compilation-process/) errors.
5555
- **The log shows lots of thinking but no useful action** — your instructions may be too vague. Keep the run open, then refine the workflow body in a later step.
5656
- **The run finishes but nothing changed in GitHub** — make sure your repository has an open issue and that the workflow had permission to write.
5757

workshop/14-next-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Take stock of everything you've learned, then choose a direction for what to bui
1818

1919
You've gone from zero to a fully automated, AI-powered workflow that:
2020

21-
- Runs on a schedule in GitHub Actions
21+
- Runs on a [schedule](https://github.github.com/gh-aw/reference/triggers/#scheduled-triggers-schedule) in GitHub Actions
2222
- Uses gh-aw to call an AI model from a simple YAML file
2323
- Posts a daily summary without any manual intervention
2424

workshop/14b-pr-reviewer-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ A few things to notice in this frontmatter:
6565
- `safe-outputs: create-issue-comment: limit: 1` caps the workflow at one comment per run, preventing spam if the workflow is triggered repeatedly.
6666
- The agent brief uses only information available in the trigger context (changed file paths, PR title, PR description) — it does not need to read raw file contents to produce a useful first-pass review.
6767

68-
## Compile and Push
68+
## [Compile](https://github.github.com/gh-aw/reference/compilation-process/) and Push
6969

7070
From your repository root, compile the workflow:
7171

workshop/16-connect-data-source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ GitHub resolves the step-output expressions before the AI sees the prompt, so th
124124

125125
✏️ Try it: Change `"two short paragraphs"` to `"one bullet list per topic"` and re-run. Notice how the output format shifts.
126126

127-
### Compile, push, and test
127+
### [Compile](https://github.github.com/gh-aw/reference/compilation-process/), push, and test
128128

129129
The `/agentic-workflows` skill recompiles the lock file automatically. If you edited the workflow manually, run `gh aw compile` first, then push:
130130

workshop/17-add-mcp-tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Open your daily-status workflow file (`.github/workflows/daily-status.md`) and f
8383
>
8484
> `mode: gh-proxy` routes all GitHub tool calls through the `GITHUB_TOKEN` that Actions provides automatically — no extra credentials or setup needed on github.com or GHEC.
8585
>
86-
> On GHES, the GitHub MCP server is supported from GHES 3.16+. If your instance is older, the `tools:` block will compile without errors but the agent's tool calls will fail at runtime. Verify your GHES version and confirm with your admin that the Copilot MCP proxy feature is enabled for your organization.
86+
> On GHES, the GitHub MCP server is supported from GHES 3.16+. If your instance is older, the `tools:` block will [compile](https://github.github.com/gh-aw/reference/compilation-process/) without errors but the agent's tool calls will fail at runtime. Verify your GHES version and confirm with your admin that the Copilot MCP proxy feature is enabled for your organization.
8787
>
8888
> If MCP is unavailable in your environment, the [Connect a Live Data Source](16-connect-data-source.md) step covers an alternative approach using deterministic shell steps that only require `GITHUB_TOKEN` and the `gh` CLI — no MCP server needed.
8989
>

workshop/18-share-and-reuse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ For example, if your username is `jsmith`, your repo is `my-workshop`, and your
6565
gh aw add jsmith/my-workshop/daily-status
6666
```
6767

68-
Your teammate runs this inside their repository. `gh aw add` copies the Markdown file into their `.github/workflows/` folder and they can then edit and compile it for their own context.
68+
Your teammate runs this inside their repository. `gh aw add` copies the Markdown file into their `.github/workflows/` folder and they can then edit and [compile](https://github.github.com/gh-aw/reference/compilation-process/) it for their own context.
6969

7070
> [!TIP]
7171
> You can also pin to a specific version using a tag or commit SHA: `gh aw add jsmith/my-workshop/daily-status@v1.0`. This is useful when you want to guarantee stability for a team-wide rollout.

workshop/19-research-driven-training-node.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Keep the comment concise and traceable to real sources you used.
6666

6767
### Validate before opening a pull request
6868

69-
Run markdown lint and compile checks so your proposal is production-ready:
69+
Run markdown lint and [compile](https://github.github.com/gh-aw/reference/compilation-process/) checks so your proposal is production-ready:
7070

7171
```bash
7272
npx --yes markdownlint-cli2 "workshop/**/*.md"

workshop/20-persistent-memory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ have already reported on. On each run:
114114
> [!TIP]
115115
> Be explicit in the brief about _reading_ and _writing_ the memory. The agent will not automatically persist anything unless you ask it to in the task brief.
116116
117-
### Compile, validate, and push
117+
### [Compile](https://github.github.com/gh-aw/reference/compilation-process/), validate, and push
118118

119119
The `/agentic-workflows` skill recompiles the lock file automatically. If you edited manually, run `gh aw compile` first to confirm the memory block is valid.
120120

0 commit comments

Comments
 (0)