Skip to content

Commit b00b00a

Browse files
bradygasterCopilot
andcommitted
docs: community docs launch — Astro fixes, contributor content, blog post
- Port @diberry's installation decision tree (PR #288) and .squad/ explainer (PR #290) into Astro docs - Apply Brady's review fixes: sidebar scroll-to-active, CLI text updates, logo fix, Copilot CLI callouts, CI/CD cron safety warning - Update CONTRIBUTORS.md with @IEvangelist (Astro docs rewrite) and @diberry (4 PRs) - Add blog post 028: New Docs Site — Built by the Community Merges community work from: - PR #293 by @IEvangelist (Astro docs rewrite) - PR #286, #288, #290, #292 by @diberry (docs improvements) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 5bb6340 commit b00b00a

9 files changed

Lines changed: 150 additions & 7 deletions

File tree

‎CONTRIBUTORS.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,8 @@ These community members shaped Squad through issues, discussions, and feedback.
9595
| Contributor | Contributions |
9696
|-------------|---------------|
9797
| [@dfberry](https://github.com/dfberry) | #241 (Squad member for docs), #157 (CFO/account member) — docs and team composition ideas |
98-
| [@diberry](https://github.com/diberry) | #211 (Squad management paradigms) — management approaches |
98+
| [@IEvangelist](https://github.com/IEvangelist) | PR #293 (Astro docs rewrite) — complete documentation site rebuild with Astro, Tailwind CSS, Pagefind search, responsive design. Massive contribution. |
99+
| [@diberry](https://github.com/diberry) | #211 (Squad management paradigms), PR #286 (Quick Start validation), PR #288 (installation decision tree), PR #290 (.squad/ directory explainer), PR #292 (doc-impact review process) — management approaches, documentation improvements across multiple PRs |
99100
| [@HemSoft](https://github.com/HemSoft) | #148 (GitHub Agent Workflows) — GAW concept |
100101
| [@sturlath](https://github.com/sturlath) | #156 (Team learning from others' work) — cross-agent learning |
101102
| [@tomasherceg](https://github.com/tomasherceg) | #184 (Multi-PR commit isolation), #237 (CLI wiring bug) — worktree improvements and bug reports |

‎docs/src/components/Sidebar.astro‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,10 @@ const base = import.meta.env.BASE_URL;
7070
}
7171

7272
overlay?.addEventListener('click', closeSidebar);
73+
74+
// Scroll the active TOC link into view on page load
75+
const activeLink = sidebar?.querySelector('.sidebar-link.active');
76+
if (activeLink && sidebar) {
77+
activeLink.scrollIntoView({ block: 'center', behavior: 'instant' });
78+
}
7379
</script>
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: "New Docs Site: Built by the Community"
3+
date: 2026-03-10
4+
author: "PAO (DevRel)"
5+
wave: 7
6+
tags: [squad, docs, community, astro, contributions]
7+
status: published
8+
hero: "Squad's documentation gets a complete rebuild — powered by Astro, Tailwind CSS, and community contributors."
9+
---
10+
11+
# New Docs Site: Built by the Community
12+
13+
> ⚠️ **Experimental** — Squad is alpha software. APIs, commands, and behavior may change between releases.
14+
15+
> _Squad's documentation site has been completely rebuilt from the ground up. A full Astro-powered docs experience with search, responsive design, and content contributed by multiple community members._
16+
17+
---
18+
19+
## What Shipped
20+
21+
### Complete Astro Docs Rewrite
22+
23+
[@IEvangelist](https://github.com/IEvangelist) (David Pine) delivered a **complete documentation site rebuild** in PR #293. This isn't a reskin — it's a ground-up rewrite:
24+
25+
- **Astro 5.7** — Static site generation with component islands
26+
- **Tailwind CSS 4.1** — Modern utility-first styling with responsive design
27+
- **Pagefind** — Client-side full-text search across all docs
28+
- **Structured content** — Markdown content collections with frontmatter validation
29+
- **Blog system** — All existing blog posts migrated into the new architecture
30+
- **Custom components** — Sidebar with scroll-to-active, syntax-highlighted code blocks, callout boxes
31+
32+
The site ships as a static build under `docs/` with its own `package.json`. Dev server: `npm run dev`. Production build: `astro build && pagefind`.
33+
34+
### Community Content from @diberry
35+
36+
[@diberry](https://github.com/diberry) (Dina Berry) submitted **four pull requests** improving the getting-started experience:
37+
38+
- **PR #286** — Added validation steps to the Quick Start README
39+
- **PR #288** — "Which method should I use?" decision tree for the installation page — CLI, VS Code, or SDK, with clear guidance on when to use each
40+
- **PR #290** — ".squad/ directory explainer" for the first-session guide — a table showing every file and directory in `.squad/` with its purpose, plus ownership guidance
41+
- **PR #292** — Doc-impact review process added to team workflows
42+
43+
All four contributions have been merged or ported into the new Astro docs structure.
44+
45+
---
46+
47+
## What Changed for Users
48+
49+
### Better Navigation
50+
51+
The sidebar now scrolls to your current position when a page loads. If you're deep in the table of contents, it stays where you are instead of jumping back to the top.
52+
53+
### Copilot CLI Callouts
54+
55+
Key pages now include callouts directing users to the **GitHub Copilot CLI** as the recommended interface:
56+
57+
```
58+
💡 The recommended way to use Squad is through GitHub Copilot CLI:
59+
copilot --agent squad
60+
```
61+
62+
### CI/CD Safety Warnings
63+
64+
The CI/CD integration page now ships with the cron schedule **commented out by default** and a warning about GitHub Actions minutes consumption when enabling heartbeats and scheduled runs.
65+
66+
---
67+
68+
## Community Impact
69+
70+
This release represents a milestone for Squad's community. Two external contributors shaped the docs you'll use:
71+
72+
| Contributor | Impact |
73+
|-------------|--------|
74+
| [@IEvangelist](https://github.com/IEvangelist) | Complete Astro docs site architecture and build |
75+
| [@diberry](https://github.com/diberry) | Four PRs improving installation, getting-started, and team workflow docs |
76+
77+
Both contributors are now credited in [CONTRIBUTORS.md](https://github.com/bradygaster/squad/blob/main/CONTRIBUTORS.md).
78+
79+
---
80+
81+
## Try It
82+
83+
Visit the docs at [bradygaster.github.io/squad](https://bradygaster.github.io/squad/) or run them locally:
84+
85+
```bash
86+
cd docs
87+
npm install
88+
npm run dev
89+
```
90+
91+
Open [localhost:4321/squad/](http://localhost:4321/squad/) and explore.
92+
93+
---
94+
95+
## What's Next
96+
97+
- Search refinements and indexing improvements
98+
- More scenario guides from community feedback
99+
- Continued content contributions welcome — see [CONTRIBUTING.md](https://github.com/bradygaster/squad/blob/main/CONTRIBUTING.md)

‎docs/src/content/docs/get-started/first-session.md‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,25 @@ Say "yes" or skip straight to a task (which is implicit confirmation):
8686
> Yes. Dallas, set up the Express server with basic routing.
8787
```
8888

89-
Squad creates the `.squad/` directory structure — team roster, routing rules, casting state, ceremony config, agent charters, and histories — all seeded with your project context. Then it spawns Dallas:
89+
Squad creates the `.squad/` directory structure — team roster, routing rules, casting state, ceremony config, agent charters, and histories — all seeded with your project context.
90+
91+
### What's inside .squad/?
92+
93+
| File/Directory | Purpose |
94+
|---|---|
95+
| `team.md` | Team roster, roles, and member info |
96+
| `routing.md` | Work routing rules (which agent handles what) |
97+
| `decisions.md` | Team decisions — all agents read this before working |
98+
| `agents/` | Each agent's charter and history (their memory) |
99+
| `ceremonies.md` | Ceremony schedule (retrospectives, reviews, etc.) |
100+
| `casting/` | Team formation history and casting state |
101+
| `skills/` | Reusable capabilities agents can learn |
102+
103+
**You own these files.** Edit them anytime — change roles, add routing rules, fix decisions. Squad reads them before every spawn.
104+
105+
**Commit `.squad/` to version control.** It's your team's brain. Anyone who clones the repo gets the team with all their knowledge.
106+
107+
Then it spawns Dallas:
90108

91109
```
92110
🔧 Dallas — setting up Express server with routing

‎docs/src/content/docs/get-started/installation.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,21 @@ npm install -g @bradygaster/squad-cli@latest
5959

6060
---
6161

62+
## Which method should I use?
63+
64+
Pick based on what you're doing:
65+
66+
| **You want to...** | **Use** | **Why** |
67+
|--------------------|---------|---------|
68+
| Try Squad quickly | **CLI** with `npx` | No install needed. Run `npx @bradygaster/squad-cli init` and you're testing it. |
69+
| Use Squad across all projects | **CLI** with `--global` | One install. Works everywhere. Run `squad` from any terminal. |
70+
| Work inside VS Code | **VS Code** (just open your project) | Already using Copilot? Squad just works. Same `.squad/` directory as CLI. |
71+
| Build tools on top of Squad | **SDK** | Typed APIs, routing config, agent lifecycle hooks. Programmatic access to everything. |
72+
73+
Can't decide? → Start with **CLI**. You can always add VS Code or the SDK later. Your `.squad/` directory works identically everywhere.
74+
75+
---
76+
6277
## 2. VS Code
6378

6479
Squad works in VS Code through GitHub Copilot. Your `.squad/` directory works identically in both CLI and VS Code — same agents, same decisions, same memory.

‎docs/src/content/docs/guide/shell.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
> ⚠️ **Experimental** — Squad is alpha software. APIs, commands, and behavior may change between releases.
44
5-
The Squad interactive shell gives you a persistent connection to your team. Instead of spawning short-lived CLI invocations, the shell maintains a real-time session where you can talk to agents, issue commands, and watch work happen.
5+
> 💡 **Recommended: Use GitHub Copilot CLI** — The best way to interact with Squad today is through the [GitHub Copilot CLI](https://docs.github.com/en/copilot/github-copilot-in-the-cli). Run `copilot --agent squad` to start a session with your team. The Copilot CLI provides the richest agent experience, including tool use, parallel execution, and full MCP integration.
6+
7+
The Squad interactive shell gives you a persistent connection to your team.Instead of spawning short-lived CLI invocations, the shell maintains a real-time session where you can talk to agents, issue commands, and watch work happen.
68

79
---
810

‎docs/src/content/docs/reference/cli.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ squad init
4949
| `squad aspire` | Launch Aspire dashboard for observability | No |
5050
| `squad aspire --docker` | Force Docker mode for Aspire | No |
5151
| `squad upstream add\|remove\|list\|sync` | Manage upstream Squad sources | Yes |
52-
| `squad shell` | Launch interactive shell explicitly | No |
52+
| `copilot --agent squad` | Launch interactive shell explicitly | No |
5353
| `squad nap` | Context hygiene (compress, prune, archive .squad/ state) | Yes |
5454
| `squad nap --deep` | Thorough cleanup with recursive descent | Yes |
5555
| `squad nap --dry-run` | Preview cleanup actions without changes | Yes |

‎docs/src/content/docs/scenarios/ci-cd-integration.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ The workflow is in `.github/workflows/squad-heartbeat.yml` and runs every 6 hour
2828
```yaml
2929
name: Ralph Heartbeat
3030
on:
31-
schedule:
32-
- cron: '0 */6 * * *' # Every 6 hours
31+
# schedule:
32+
# - cron: '0 */6 * * *' # Every 6 hours
3333
workflow_dispatch:
3434

3535
jobs:
@@ -41,6 +41,8 @@ jobs:
4141
run: squad heartbeat
4242
```
4343
44+
> ⚡ **Cron is commented out by default.** The heartbeat schedule is disabled when Squad installs the workflow — it only runs via manual `workflow_dispatch` until you uncomment the `schedule` block. Be aware: enabling scheduled heartbeats will consume GitHub Actions minutes on every run. A 6-hour cron burns ~120 runs/month. Adjust the frequency to match your budget, or leave it manual and trigger heartbeats from the CLI with `squad heartbeat`.
45+
4446
Ralph reads `.squad/routing.md`, looks at open issues, and applies labels:
4547

4648
```

‎docs/src/pages/index.astro‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ const base = import.meta.env.BASE_URL;
266266
<div class="inline-flex items-center justify-center w-12 h-12 rounded-2xl bg-squad-600 text-white font-bold text-lg mb-5 shadow-lg shadow-squad-600/25">3</div>
267267
<h3 class="font-semibold text-surface-900 dark:text-white mb-2">Ship</h3>
268268
<p class="text-sm text-surface-600 dark:text-surface-400 mb-4 flex-1">Talk to your team — they build, test, and land PRs.</p>
269-
<code class="text-sm font-mono bg-surface-100 dark:bg-surface-800 text-surface-700 dark:text-green-400 px-3 py-1.5 rounded-lg border border-surface-200 dark:border-transparent">squad shell</code>
269+
<code class="text-sm font-mono bg-surface-100 dark:bg-surface-800 text-surface-700 dark:text-green-400 px-3 py-1.5 rounded-lg border border-surface-200 dark:border-transparent">copilot --agent squad</code>
270270
</div>
271271
</div>
272272
</div>

0 commit comments

Comments
 (0)