Repository navigation
docs: consolidate Squad 2.0 multi-client and experimental backend documentation [4/4] - #2254
Conversation
🏗️ Architectural Review
Automated architectural review — informational only. |
🛫 PR Readiness Check
PR Scope: 🔧 Infrastructure
|
| Status | Check | Details |
|---|---|---|
| ❌ | Single commit | 3 commits — consider squashing before review |
| ✅ | Not in draft | Ready for review |
| ✅ | Branch up to date | Up to date with tamirdresher-microsoft-stack-3-experimental-backend |
| ❌ | Copilot review | No Copilot review yet — it may still be processing |
| ✅ | Changeset present | Changeset file found |
| ✅ | 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 | All checks passing |
Files Changed (20 files, +1228 −21)
| File | +/− |
|---|---|
.changeset/squad-2-0-multi-host-clients.md |
+14 −6 |
CONTRIBUTING.md |
+11 −0 |
README.md |
+13 −2 |
docs/SQUAD-2.0-OVERVIEW.md |
+116 −0 |
docs/specification/client-backend-decoupling-v0.2.md |
+9 −5 |
docs/specification/client-harness-adapters-v0.2.md |
+5 −4 |
docs/src/content/docs/concepts/squad-2-0-architecture.md |
+163 −0 |
docs/src/content/docs/get-started/migration.md |
+17 −1 |
docs/src/content/docs/reference/cli.md |
+6 −0 |
docs/src/content/docs/reference/config.md |
+5 −0 |
docs/src/content/docs/reference/sdk.md |
+20 −1 |
docs/src/content/docs/scenarios/client-compatibility.md |
+2 −0 |
docs/src/content/docs/scenarios/upgrading.md |
+60 −0 |
docs/src/content/docs/scenarios/using-squad-across-clients.md |
+146 −0 |
docs/src/content/docs/whatsnew.md |
+19 −1 |
docs/src/navigation.ts |
+2 −0 |
docs/tutorials/durable-backend-and-custom-harness.md |
+270 −0 |
docs/tutorials/multi-client-quickstart.md |
+95 −0 |
test/docs-build.test.ts |
+2 −1 |
test/squad-20-pack-smoke.test.ts |
+253 −0 |
Total: +1228 −21
This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.
🟡 Impact Analysis — PR #2254Risk tier: 🟡 MEDIUM 📊 Summary
🎯 Risk Factors
📦 Modules Affecteddocs (15 files)
root (3 files)
tests (2 files)
This report is generated automatically for every PR. See #733 for details. |
There was a problem hiding this comment.
🟡 Changes recommended
Backend examples mishandle capability negotiation and approval identity, and reference guidance incorrectly implies automatic SDK environment configuration.
3 open issues
What changed in this PR
Consolidates Squad 2.0 documentation into the published site, covering multi-host projections and the experimental backend contract.
Changes:
- Documents all seven hosts and the canonical
/clientimport. - Adds backend opt-in guidance, limitations, and tutorials.
- Updates navigation, documentation checks, specifications, and contributor guidance.
| File | Description |
|---|---|
test/docs-build.test.ts |
Checks the new documentation pages. |
README.md |
Introduces multi-host commands and guides. |
docs/tutorials/multi-client-quickstart.md |
Adds host setup and projection examples. |
docs/tutorials/durable-backend-and-custom-harness.md |
Adds backend and custom harness examples. |
docs/src/navigation.ts |
Links the new published guides. |
docs/src/content/docs/scenarios/using-squad-across-clients.md |
Provides seven-host walkthroughs. |
docs/src/content/docs/scenarios/client-compatibility.md |
Links multi-host guidance. |
docs/src/content/docs/reference/sdk.md |
Documents client and backend APIs. |
docs/src/content/docs/reference/config.md |
Describes client metadata and backend variables. |
docs/src/content/docs/reference/cli.md |
Documents projection commands and experimental flags. |
docs/src/content/docs/concepts/squad-2-0-architecture.md |
Explains architecture and conformance contracts. |
docs/SQUAD-2.0-OVERVIEW.md |
Summarizes architecture and links canonical guides. |
docs/specification/client-harness-adapters-v0.2.md |
Aligns host projection requirements. |
docs/specification/client-backend-decoupling-v0.2.md |
Expands host and transport coverage. |
CONTRIBUTING.md |
Adds host-adapter contribution steps. |
Review effort: Balanced
…notes & pack smoke test - Clarify in reference/sdk.md, reference/config.md, and reference/cli.md that createSquadBackend / DurableHttpSquadBackend require explicit baseUrl (and optional token), while automatic SQUAD_BACKEND_URL / SQUAD_BACKEND_TOKEN lookup applies only to squad state-mcp when experimental backend tools are enabled - Use canonical BACKEND_CAPABILITIES tokens (cursor-reconnect, approvals, cancel-run, typed-content-parts) in durable-backend-and-custom-harness.md - Give each turn a distinct approvalId and track (runId, seq) per conversation and approvalId in DemoHarnessAdapter - Update .changeset/squad-2-0-multi-host-clients.md with major bumps for @bradygaster/squad, @bradygaster/squad-sdk, and @bradygaster/squad-cli and release-notes summary - Add v2.0.0 release notes to whatsnew.md, Upgrading to Squad 2.0 section to scenarios/upgrading.md and get-started/migration.md, and host capability matrix / Phase 2 limitations to architecture and multi-client docs - Add test/squad-20-pack-smoke.test.ts for npm pack clean-install and v1.1.0 -> 2.0 upgrade/rollback verification Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 3ed7a60c-f40f-40e8-8b56-c39cf1a0ffe9
…osts (Layer 4) Split from #2239 (Layer 4 of 4): - Canonicalize @bradygaster/squad-sdk/client across architecture, overview, quickstart, and SDK docs - Add Experimental Preview / Bring Your Own Server callouts for @bradygaster/squad-sdk/backend and document opt-in --experimental-backend / SQUAD_EXPERIMENTAL_BACKEND=1 MCP tools - Update all 5-host lists to all 7 hosts (copilot, claude, kiro, opencode, cursor, codex, antigravity) and align generated-file tables with Layer 1 projections - Consolidate architecture and multi-client docs into published Astro pages and align v0.2 specs Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 3ed7a60c-f40f-40e8-8b56-c39cf1a0ffe9
…re lines, backend opt-in and harness caveats, https-only durable-http) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 92888fd8-c715-4d1d-a60f-893a7a157841
…notes & pack smoke test - Clarify in reference/sdk.md, reference/config.md, and reference/cli.md that createSquadBackend / DurableHttpSquadBackend require explicit baseUrl (and optional token), while automatic SQUAD_BACKEND_URL / SQUAD_BACKEND_TOKEN lookup applies only to squad state-mcp when experimental backend tools are enabled - Use canonical BACKEND_CAPABILITIES tokens (cursor-reconnect, approvals, cancel-run, typed-content-parts) in durable-backend-and-custom-harness.md - Give each turn a distinct approvalId and track (runId, seq) per conversation and approvalId in DemoHarnessAdapter - Update .changeset/squad-2-0-multi-host-clients.md with major bumps for @bradygaster/squad, @bradygaster/squad-sdk, and @bradygaster/squad-cli and release-notes summary - Add v2.0.0 release notes to whatsnew.md, Upgrading to Squad 2.0 section to scenarios/upgrading.md and get-started/migration.md, and host capability matrix / Phase 2 limitations to architecture and multi-client docs - Add test/squad-20-pack-smoke.test.ts for npm pack clean-install and v1.1.0 -> 2.0 upgrade/rollback verification Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 3ed7a60c-f40f-40e8-8b56-c39cf1a0ffe9
ee407cb to
c7190a8
Compare

Summary (Stack Layer 4 of 4 — splits #2239)
Consolidates the Squad 2.0 documentation into the published Astro Starlight site (
squad-2-0-architecture.md,using-squad-across-clients.md, and reference pages) and aligns the specification suite.Review fixes included in Layer 4
@bradygaster/squad-sdk/clientas the canonical import path across all docs and samples (noting/clientsonly as a deprecated alias).durable-http//backendsections clarifying that Squad ships only the contract, local backend, and outbound HTTP client, plus the opt-in--experimental-backend/SQUAD_EXPERIMENTAL_BACKEND=1MCP flag.copilot,claude,kiro,opencode,cursor,codex,antigravity) and reflects the Layer 1 projections (.codex/agents/squad.md+AGENTS.mdpointer block, Kiroinclusion: manual, CursoralwaysApply: false, Antigravity frontmatter MCP).docs/SQUAD-2.0-OVERVIEW.mdanddocs/tutorials/*.md.