Skip to content

Commit 97f54f1

Browse files
workshop docs: add gh-aw doc links to steps 07a-08b (#1352)
1 parent 7e6f343 commit 97f54f1

5 files changed

Lines changed: 33 additions & 5 deletions

workshop/07a-your-first-workflow-terminal.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ _Writing your first workflow is the moment theory becomes practice — let's mak
77
88
## 🎯 What You'll Do
99

10-
You'll create the first version of `.github/workflows/daily-report-status.md` with just two frontmatter fields:
10+
You'll create the first version of `.github/workflows/daily-report-status.md` with just two [frontmatter](https://github.github.com/gh-aw/reference/frontmatter/) fields:
1111

1212
- `name` (workflow label)
1313
- `on.workflow_dispatch` (manual trigger)
@@ -102,3 +102,11 @@ Continue to [Part 2: Add instructions, safe outputs, and finish](07a-part2-your-
102102
- [ ] The frontmatter includes `name` and `on.workflow_dispatch`
103103
- [ ] `gh aw compile` succeeds and generates `daily-report-status.lock.yml`
104104
- [ ] `gh extension list` shows `github/gh-aw` is installed
105+
106+
## 📚 See Also
107+
108+
- [Overview of GitHub Agentic Workflows](https://github.github.com/gh-aw/introduction/overview/)
109+
- [Frontmatter reference](https://github.github.com/gh-aw/reference/frontmatter/)
110+
- [Triggers reference](https://github.github.com/gh-aw/reference/triggers/#dispatch-triggers-workflowdispatch)
111+
- [Compilation Process](https://github.github.com/gh-aw/reference/compilation-process/)
112+
- [Workflow Structure](https://github.github.com/gh-aw/reference/workflow-structure/)

workshop/07b-your-first-workflow-ui.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You'll create a complete `daily-report-status.md` workflow in the GitHub web edi
1515

1616
## Understand the file
1717

18-
An agentic workflow source file is a Markdown task brief with YAML frontmatter. GitHub Actions runs the compiled `.lock.yml`; you edit the `.md` source first, then compile it into the `.lock.yml` file before Step 8.
18+
An agentic workflow source file is a Markdown task brief with YAML [frontmatter](https://github.github.com/gh-aw/reference/frontmatter/). GitHub Actions runs the compiled `.lock.yml`; you edit the `.md` source first, then [compile](https://github.github.com/gh-aw/reference/compilation-process/) it into the `.lock.yml` file before Step 8.
1919

2020
## Create the workflow
2121

@@ -96,4 +96,7 @@ Review the proposed diff. Confirm both `.github/workflows/daily-report-status.md
9696
## 📚 See Also
9797

9898
- [Overview of GitHub Agentic Workflows](https://github.github.com/gh-aw/introduction/overview/)
99+
- [Frontmatter reference](https://github.github.com/gh-aw/reference/frontmatter/)
100+
- [Triggers reference](https://github.github.com/gh-aw/reference/triggers/)
99101
- [Safe Outputs reference](https://github.github.com/gh-aw/reference/safe-outputs/)
102+
- [Compilation Process](https://github.github.com/gh-aw/reference/compilation-process/)

workshop/07c-your-first-workflow-copilot.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The workflow must:
2424
- Be named "Daily Report Status"
2525
- Support manual runs with `workflow_dispatch`
2626
- Use `contents: read`, `issues: read`, and `copilot-requests: write`
27-
- Allow at most one comment and at most one new issue through safe outputs
27+
- Allow at most one comment and at most one new issue through [safe outputs](https://github.github.com/gh-aw/reference/safe-outputs/)
2828
- Search open issues for the issue with the most 👍 reactions and comment:
2929
"This issue has the most community support! We'll prioritise it in our next planning session."
3030
- Create an issue titled "Community Voting Test" and post the same comment if no open issues exist
@@ -57,3 +57,11 @@ Before you approve the merge, the agent presents the file changes in its session
5757
- [ ] You are ready to choose the workflow's billing and authentication method
5858

5959
**Next:** [Step 7d: Confirm Model Access](07d-confirm-model-access.md)
60+
61+
## 📚 See Also
62+
63+
- [Overview of GitHub Agentic Workflows](https://github.github.com/gh-aw/introduction/overview/)
64+
- [Safe Outputs reference](https://github.github.com/gh-aw/reference/safe-outputs/)
65+
- [Triggers reference](https://github.github.com/gh-aw/reference/triggers/)
66+
- [Compilation Process](https://github.github.com/gh-aw/reference/compilation-process/)
67+
- [AI Engines reference](https://github.github.com/gh-aw/reference/engines/)

workshop/07d-confirm-model-access.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ You'll choose the billing and authentication method for the first workflow, conf
1313

1414
Open `.github/workflows/daily-report-status.md`. The Step 7 workflow has no `engine:` line, so it uses GitHub Copilot.
1515

16-
Claude and Codex are optional engines introduced in later side quests. You do not need an Anthropic or OpenAI API key for this first run.
16+
Claude and Codex are optional [engines](https://github.github.com/gh-aw/reference/engines/) introduced in later side quests. You do not need an Anthropic or OpenAI API key for this first run.
1717

1818
## Choose one Copilot billing path
1919

@@ -59,3 +59,10 @@ Open `daily-report-status.md` and confirm it matches the method you selected:
5959
- [ ] I am ready for [Step 8: Run and Watch Your Workflow](08-run-your-workflow.md)
6060

6161
**Next:** [Step 8: Run and Watch Your Workflow](08-run-your-workflow.md)
62+
63+
## 📚 See Also
64+
65+
- [AI Engines reference](https://github.github.com/gh-aw/reference/engines/)
66+
- [Authentication reference](https://github.github.com/gh-aw/reference/auth/)
67+
- [GitHub Tools Read Permissions](https://github.github.com/gh-aw/reference/permissions/#special-permission-copilot-requests-write)
68+
- [Billing reference](https://github.github.com/gh-aw/reference/billing/)

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The important question is not "Can I read every line?" It is "Can I tell where t
3030

3131
After the run finishes, scroll to the **Summary** section on the run page. This gives you the short version of what the agent believes it did, including the safe-output action it used.
3232

33-
Then verify the real output in your repository. For **Daily Report Status**, that usually means opening the issue the agent touched and confirming the comment or new issue is actually there. The GitHub change is the ground truth behind the safe-output record.
33+
Then verify the real output in your repository. For **Daily Report Status**, that usually means opening the issue the agent touched and confirming the comment or new issue is actually there. The GitHub change is the ground truth behind the [safe-output](https://github.github.com/gh-aw/reference/safe-outputs/) record.
3434

3535
![Workflow run summary panel](images/08-run-summary.svg)
3636

@@ -58,3 +58,5 @@ For a deeper troubleshooting guide, see [Step 9: Reading Workflow Output](09-und
5858

5959
- [Overview of GitHub Agentic Workflows](https://github.github.com/gh-aw/introduction/overview/)
6060
- [Safe Outputs reference](https://github.github.com/gh-aw/reference/safe-outputs/)
61+
- [Compilation Process](https://github.github.com/gh-aw/reference/compilation-process/)
62+
- [Auditing Workflows](https://github.github.com/gh-aw/reference/audit/)

0 commit comments

Comments
 (0)