Context
Closes part of #18481 — gh-aw in forks.
There is currently no documentation explaining how gh-aw behaves in forked repositories, what works, what doesn't, and how to set things up correctly.
Objective
Add a documentation page on fork support under docs/ covering the compatibility matrix, required setup steps for fork users, and explanation of design decisions.
Approach
-
Create a new documentation page, e.g., docs/src/content/docs/guides/fork-support.md (follow the existing Diátaxis/Starlight conventions used in docs/).
-
The page should include:
-
Overview: two fork scenarios (inbound fork PRs vs. running gh-aw in a fork)
-
Compatibility table (based on the scout report):
| Feature |
Status in Fork |
Notes |
pull_request fork filtering |
✅ Works |
Compiler injects repo ID check |
workflow_run cross-fork safety |
✅ Works |
Fork check injected at compile time |
| Running your own workflows |
⚠️ Partial |
Must configure own secrets |
| Agentic maintenance |
⚠️ Skipped |
Fork detection added; skips gracefully |
| Slash commands |
⚠️ Partial |
Works if secrets configured |
| Secrets |
❌ Not inherited |
Must reconfigure in fork settings |
-
Setup guide: step-by-step for configuring required secrets in a fork
-
forks: frontmatter field: explanation of allow-listing trusted forks
-
Known limitations: features that won't work regardless of secret setup
-
Reference the documentation skill (skills/documentation.md) for style/format guidelines.
-
Verify the page renders correctly in the docs site structure.
Files to Create/Modify
docs/src/content/docs/guides/fork-support.md (new)
- Possibly update
docs/src/content/docs/guides/ index or sidebar config
Acceptance Criteria
Generated by Plan Command for issue #18481
Context
Closes part of #18481 — gh-aw in forks.
There is currently no documentation explaining how gh-aw behaves in forked repositories, what works, what doesn't, and how to set things up correctly.
Objective
Add a documentation page on fork support under
docs/covering the compatibility matrix, required setup steps for fork users, and explanation of design decisions.Approach
Create a new documentation page, e.g.,
docs/src/content/docs/guides/fork-support.md(follow the existing Diátaxis/Starlight conventions used indocs/).The page should include:
Overview: two fork scenarios (inbound fork PRs vs. running gh-aw in a fork)
Compatibility table (based on the scout report):
pull_requestfork filteringworkflow_runcross-fork safetySetup guide: step-by-step for configuring required secrets in a fork
forks:frontmatter field: explanation of allow-listing trusted forksKnown limitations: features that won't work regardless of secret setup
Reference the documentation skill (
skills/documentation.md) for style/format guidelines.Verify the page renders correctly in the docs site structure.
Files to Create/Modify
docs/src/content/docs/guides/fork-support.md(new)docs/src/content/docs/guides/index or sidebar configAcceptance Criteria
forks:frontmatter field documentedRelated to Using gh-aw in forks of repositories #18481