docs: add gh-aw slash commands and setup guide - #1636
Merged
Conversation
Covers installation, all slash commands, casting brief, connect vs adopt, and iteration patterns for GitHub Agentic Workflows. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
🛫 PR Readiness Check
PR Scope: 🔧 Infrastructure
|
| Status | Check | Details |
|---|---|---|
| ❌ | Single commit | 5 commits — consider squashing before review |
| ✅ | Not in draft | Ready for review |
| ✅ | Branch up to date | Up to date with dev |
| ❌ | Copilot review | No Copilot review yet — it may still be processing |
| ✅ | Changeset present | No source files changed — changeset not required |
| ✅ | Scope clean | No .squad/ or docs/proposals/ files |
| ✅ | No merge conflicts | No merge conflicts |
| ✅ | Copilot threads resolved | 0 active Copilot thread(s) resolved (3 outdated skipped) |
| ❌ | CI passing | 8 check(s) still running |
Files Changed (5 files, +436 −2)
| File | +/− |
|---|---|
.github/workflows/squad-docs.yml |
+1 −1 |
README.md |
+35 −0 |
docs/src/content/docs/guide/gh-aw.md |
+398 −0 |
docs/src/navigation.ts |
+1 −0 |
test/docs-build.test.ts |
+1 −1 |
Total: +436 −2
This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.
Contributor
🟡 Impact Analysis — PR #1636Risk tier: 🟡 MEDIUM 📊 Summary
🎯 Risk Factors
📦 Modules Affectedci-workflows (1 file)
docs (2 files)
root (1 file)
tests (1 file)
This report is generated automatically for every PR. See #733 for details. |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new end-to-end documentation page (docs/gh-aw.md) explaining how to set up and use Squad via GitHub Agentic Workflows (gh aw), including command reference, casting brief guidance, workflow architecture, and troubleshooting.
Changes:
- Introduces a comprehensive
gh awsetup + quick start guide for enabling/squadin a repository. - Documents all major
/squadmodes, expected generated files, and Connect vs Adopt behavior. - Explains workflow execution (activation vs sandboxed agent job) and common troubleshooting scenarios.
Show a summary per file
| File | Description |
|---|---|
| docs/gh-aw.md | New documentation page for Squad’s gh aw integration, setup, command reference, and usage patterns |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 3
- Review effort level: Lite
Comment on lines
+128
to
+131
| | `/squad cast-member <description>` | Add a single specialist to an existing team | | ||
| | `/squad cast-member rename <name> to <new-focus>` | Change an existing member's specialty | | ||
| | `/squad retire <name>` | Remove a team member (archived, not deleted) | | ||
| | `/squad status` | Report current team composition (read-only, no PR) | |
Comment on lines
+307
to
+309
| Squad allocates a character name from the existing universe, generates a charter, | ||
| and opens a PR (or pushes to the existing Squad PR if you comment on one). | ||
|
|
Comment on lines
+340
to
+342
| When you comment `/squad cast-member` or `/squad retire` on a PR that already | ||
| has the `squad` label and is on a `squad/*` branch, the changes are pushed to | ||
| that branch as a follow-up PR — keeping all squad changes in one review thread. |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Enables docs deployment on push to dev so documentation updates (including the new gh-aw guide) can go live without waiting for a merge to main. Closes #0 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
🏗️ Architectural Review
Automated architectural review — informational only. |
bradygaster
requested a deployment
to
github-pages
August 7, 2026 23:45 — with 
GitHub Actions
Waiting
GitHub Actions
Waiting
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a comprehensive documentation page at
docs/gh-aw.mdcovering Squad's GitHub Agentic Workflows integration — from prerequisites and setup through every slash command and daily usage patterns.What's covered
cast,connect,adopt,cast-member,retire,statusContext
This complements #1622 (the
gh awworkflow definition) and #1635 (the casting brief feature from #1634). Written for developers who have never used Squad before — concrete commands, practical examples, no assumptions.Working as PAO (DevRel).
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com