|
| 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) |
0 commit comments