Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/src/content/docs/get-started/five-minute-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,20 @@ You'll see:
```
✅ Squad installed.
.github/agents/squad.agent.md — coordinator agent
.squad/templates/ — 11 template files
.github/workflows/ — 5 GitHub workflows (heartbeat, triage, CI, etc.)
.squad/templates/ — 11 template files

Open GitHub Copilot and select Squad from the agent list.
```

> **Don't forget:** Commit the generated files — workflows won't run until they're on your default branch.
>
> ```bash
> git add .github/ .squad/
> git commit -m "chore: initialize squad team"
> git push
> ```

---

## Validate
Expand Down
63 changes: 63 additions & 0 deletions docs/src/content/docs/get-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,72 @@ This creates:

```
.github/agents/squad.agent.md — coordinator agent
.github/workflows/ — GitHub workflows (see below)
.squad/ — team state directory
.squad/templates/ — template files for casting, routing, ceremonies
```

### What `squad init` installs

Beyond the coordinator agent and team state, `squad init` creates GitHub workflows in `.github/workflows/`:

| Workflow | Purpose |
|----------|---------|
| `squad-heartbeat.yml` | Ralph's triage loop — auto-assigns issues to squad members based on routing rules |
| `squad-triage.yml` | Issue triage automation |
| `squad-issue-assign.yml` | Auto-assign issues to squad members |
| `squad-label-enforce.yml` | Label state machine enforcement |
| `squad-ci.yml` | Build & test integration |

> **Important:** These workflows are created but may need a separate commit. If `squad init` is run inside a Copilot session, the generated workflow files are staged but not committed. Commit them explicitly:
>
> ```bash
> git add .github/workflows/ .github/agents/ .squad/
> git commit -m "chore: initialize squad team"
> ```

### Enabling the heartbeat schedule

The heartbeat workflow runs Ralph's triage automatically. By default, the cron schedule is **disabled** — it only triggers on issue/PR events and manual dispatch. To enable periodic triage:

1. Open `.github/workflows/squad-heartbeat.yml`
2. Uncomment the `schedule` block:

```yaml
on:
schedule:
# Every 30 minutes — adjust to your team's pace
- cron: '*/30 * * * *'
```

**Common schedule examples:**

| Schedule | Cron Expression |
|----------|----------------|
| Every 30 minutes | `*/30 * * * *` |
| Every hour | `0 * * * *` |
| Every 4 hours during business hours | `0 9-17/4 * * 1-5` |
| Once daily at 9 AM UTC | `0 9 * * *` |

### Adding Squad to an existing project

Already have a running project? `squad init` works the same way — it won't overwrite your existing files:

```bash
cd my-existing-project
squad init
```

**Tip:** After initializing, give Squad context about your project in your first session:

```
> This is a React + Node.js task management app. We use PostgreSQL,
> deploy to AWS, and follow trunk-based development. The main entry
> points are src/server/index.ts and src/client/App.tsx.
```

Squad uses this to form a team matched to your stack and write accurate routing rules. See [Adding Squad to an Existing Repo](../scenarios/existing-repo.md) for a detailed walkthrough.

### Configuration (optional)

For typed configuration, create a `squad.config.ts` at your project root:
Expand Down
Loading