docs: add feature pages for preset, cross-squad discover/delegate, and coordinator-as-agent export#1274
Merged
Merged
Conversation
…d coordinator-as-agent export Closes part of #1272 — covers 3 of the 11 undocumented v0.10 user-facing features identified in the docs-gap audit. Files added: docs/src/content/docs/features/preset.md (205 lines) docs/src/content/docs/features/cross-squad-discover.md (158 lines) docs/src/content/docs/features/coordinator-as-agent-export.md (237 lines) Source verification: - preset.md sourced from packages/squad-cli/src/cli/commands/preset.ts - cross-squad-discover.md sourced from packages/squad-cli/src/cli/commands/cross-squad.ts and packages/squad-sdk/src/runtime/cross-squad.ts - coordinator-as-agent-export.md sourced from PR #1180 body and packages/squad-sdk/src/repo-native/ scope Style matches existing feature pages (loop.md, plugins.md format). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
🛫 PR Readiness Check
PR Scope: 🔧 Infrastructure
|
| Status | Check | Details |
|---|---|---|
| ✅ | Single commit | 1 commit — clean history |
| ✅ | 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 | No Copilot review threads |
| ❌ | CI passing | 1 check(s) still running |
Files Changed (3 files, +600 −0)
| File | +/− |
|---|---|
docs/src/content/docs/features/coordinator-as-agent-export.md |
+237 −0 |
docs/src/content/docs/features/cross-squad-discover.md |
+158 −0 |
docs/src/content/docs/features/preset.md |
+205 −0 |
Total: +600 −0
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 #1274Risk tier: 🟢 LOW 📊 Summary
🎯 Risk Factors
📦 Modules Affecteddocs (3 files)
This report is generated automatically for every PR. See #733 for details. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds three new user-facing feature documentation pages under docs/src/content/docs/features/ to improve v0.10 docs coverage for presets, cross-squad orchestration (discover/delegate), and coordinator-as-agent export.
Changes:
- Add a new docs page for
squad presetworkflows (list/show/apply/save/init +squad init --preset). - Add a new docs page for cross-squad orchestration via
squad discover/squad delegate, including manifest format. - Add a new docs page intended to document “coordinator-as-agent export”.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| docs/src/content/docs/features/preset.md | New feature page documenting presets and related CLI flows. |
| docs/src/content/docs/features/cross-squad-discover.md | New feature page documenting cross-squad discover/delegate and manifest structure. |
| docs/src/content/docs/features/coordinator-as-agent-export.md | New feature page intended to document coordinator-as-agent export and CI drift checking. |
Comment on lines
+201
to
+205
| ## See also | ||
|
|
||
| - [Export & Import](/squad/docs/features/export-import/) — full squad snapshots including state | ||
| - [Skills](/squad/docs/features/skills/) — earned knowledge (separate from presets) | ||
| - [Plugin Marketplace](/squad/docs/features/plugins/) — community-curated bundles |
|
|
||
| ## What presets capture | ||
|
|
||
| Presets capture **agents only** (charters). For full squad snapshots including casting state, skills, routing rules, and decisions — for example to share a configured squad or publish to an agent toolbox — use [`squad export`](/squad/docs/features/export-import/) instead. |
Comment on lines
+35
to
+39
| When you run `squad discover`, Squad reads manifests from: | ||
| - **Upstream** — repos declared in your `.squad/upstreams/` | ||
| - **Registry** — any registry sources configured | ||
| - **Local** — manifests inside the current repo | ||
|
|
Comment on lines
+72
to
+75
| This creates an issue in `myorg/platform` titled `[cross-squad] Add Grafana dashboards...` with: | ||
| - Squad's discovered labels applied automatically | ||
| - A structured body with the originating repo, target squad, description, and acceptance criteria | ||
| - The created issue's URL printed to your terminal |
Comment on lines
+154
to
+158
| ## See also | ||
|
|
||
| - [Distributed Mesh](/squad/docs/features/distributed-mesh/) — the broader cross-repo coordination architecture | ||
| - [Multiple Squads](/squad/docs/scenarios/multiple-squads/) — running several squads in one organization | ||
| - [Upstream Inheritance](/squad/docs/features/upstream-inheritance/) — how upstreams get discovered |
Comment on lines
+10
to
+13
| **Try this to generate a coordinator agent:** | ||
| ```bash | ||
| squad export agent | ||
| ``` |
Comment on lines
+25
to
+26
| `squad export agent` compiles your `.squad/` state — team roster, routing rules, ceremony triggers, agent charters — into a single repository-native Copilot custom agent at `.github/agents/squad.md`. The generated file works across **every** Copilot surface (CLI, VS Code, GitHub Desktop, github.com) without requiring the Squad runtime installed. | ||
|
|
Comment on lines
+221
to
+228
| The export pipeline lives at `packages/squad-sdk/src/repo-native/`: | ||
|
|
||
| 1. **Context loader** — parses `.squad/` files into a typed IR | ||
| 2. **Prompt compiler** — renders the coordinator prompt with budget enforcement | ||
| 3. **Frontmatter renderer** — emits valid custom-agent YAML | ||
| 4. **File writer** — handles safety checks and atomic write | ||
|
|
||
| You can use the SDK module directly if you want to embed coordinator export into your own tooling — see `@bradygaster/squad-sdk/repo-native`. |
Comment on lines
+232
to
+237
| ## See also | ||
|
|
||
| - [Export & Import](/squad/docs/features/export-import/) — full state snapshots (different from this) | ||
| - [Self Upgrade](/squad/docs/features/self-upgrade/) — keeping the CLI itself updated | ||
| - [Multiple Squads](/squad/docs/scenarios/multiple-squads/) — when one team gets too large | ||
| - [Team Setup](/squad/docs/features/team-setup/) — composing the team that gets exported |
bradygaster
approved these changes
Jun 13, 2026
bradygaster
left a comment
bradygaster
left a comment
Owner
There was a problem hiding this comment.
✅ Flight approves. Pure docs addition, no code changes.
tamirdresher
added a commit
that referenced
this pull request
Jun 14, 2026
…, reflect, error-recovery, teams-comms, fleet-dispatch, mcp-frontmatter, dual-mode, skill-security-scanner) + export-import --repo/--branch (#1276) * docs: add feature pages for remaining 8 undocumented v0.10 features Closes the rest of #1272 — covers the 8 user-facing features that had no dedicated docs page after PR #1274 (which covered preset, cross-squad discover, and coordinator-as-agent export). New pages (8): docs/features/tiered-memory.md (hot/cold/wiki memory model) docs/features/reflect.md (in-session learning skill) docs/features/error-recovery.md (failure recovery skill) docs/features/teams-comms.md (Microsoft Teams adapter) docs/features/fleet-dispatch.md (/fleet hybrid dispatch) docs/features/mcp-frontmatter.md (--mcp-frontmatter flag) docs/features/dual-mode-deployment.md (SQUAD_POD_ID, dual-mode capabilities) docs/features/skill-security-scanner.md (markdown-aware skill scanner) Updated (1): docs/features/export-import.md (added --repo / --branch sections) Source verification: - tiered-memory.md ← packages/squad-cli/templates/skills/tiered-memory/SKILL.md - reflect.md ← packages/squad-cli/templates/skills/reflect/SKILL.md - error-recovery.md ← packages/squad-cli/templates/skills/error-recovery/SKILL.md - teams-comms.md ← packages/squad-sdk/src/platform/comms-teams.ts + changeset - fleet-dispatch.md ← packages/squad-cli/src/cli/commands/watch/capabilities/fleet-dispatch.ts - mcp-frontmatter.md ← packages/squad-cli/src/cli-entry.ts:346 flag + init flow - dual-mode-deployment.md ← packages/squad-sdk/src/ralph/capabilities.ts - skill-security-scanner.md ← scripts/security-review.mjs + changeset - export-import.md edits ← packages/squad-cli/src/cli/commands/import.ts:817 Style matches existing feature pages (loop.md, plugins.md, preset.md format). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix(cspell): whitelist PKCE/MSAL/AKIA/runas + intentional 'typoo' example CI failure on docs-quality: cspell flagged 9 words across 3 of the new feature pages added by this PR. All 9 are legitimate technical terms or intentional content (not typos): - PKCE (RFC 7636 — OAuth Proof Key for Code Exchange) — 5 hits in teams-comms.md - MSAL (Microsoft Authentication Library) — 1 hit in teams-comms.md - AKIA (AWS access key ID prefix) — 1 hit in skill-security-scanner.md - runas (Windows runas elevation primitive) — 1 hit in skill-security-scanner.md - 'typoo' — an INTENTIONAL typo in an error-recovery example showing 'don't retry the user's typo by adding another character' Added all 5 to cspell.json. Verified locally: npx cspell --no-progress --dot 'docs/src/content/**/*.md' 'README.md' → 0 issues across 166 files. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Tamir Dresher <tamirdresher@users.noreply.github.com>
4 tasks
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.
What
Adds 3 user-facing documentation pages for features that ship in v0.10 but currently have no dedicated docs page anywhere in the repo:
docs/features/preset.mdpackages/squad-cli/src/cli/commands/preset.tsdocs/features/cross-squad-discover.mdpackages/squad-cli/src/cli/commands/cross-squad.ts+packages/squad-sdk/src/runtime/cross-squad.tsdocs/features/coordinator-as-agent-export.mdpackages/squad-sdk/src/repo-native/scopeWhy
Per #1272, ~37% of v0.10 user-facing features had no docs page. The 3 covered here are the highest priority:
squad preset— has a user-visible CLI command surface (list,show,apply,save,init), often the first thing new users encounter viasquad init --preset. Live site sitemap had 0 pages matchingpreset.squad discover/squad delegate— cross-squad orchestration commands that ship in code but were only obliquely covered indistributed-mesh.md. Users searching for "discover" or "delegate" found nothing on the live site.squad export agent— Brady's coordinator-as-agent feature from PR feat: Coordinator-as-Agent export — compile .squad/ into .github/agents/squad.md #1180. Major architectural feature with no entry on the live site.Style
Pages follow the established feature-doc pattern (matches
loop.md,plugins.md):Verification
Each page was written against the actual source code paths — no fabricated commands, no inferred behavior. Cross-checked every flag and subcommand against
packages/squad-cli/src/cli-entry.ts.Not in scope for this PR
The remaining 8 undocumented features from #1272 still need pages:
mcp-frontmatter-init,tiered-memory,teams-comms-adapter,reflect-skill,error-recovery-skill,repo-import-export,skill-security-scanner,fleet-dispatch-hybrid,dual-mode-capabilitiesHappy to do those in follow-up PRs — kept this one focused so it's easier to review.
Related