Skip to content

docs: add feature pages for remaining 8 v0.10 features (tiered-memory, reflect, error-recovery, teams-comms, fleet-dispatch, mcp-frontmatter, dual-mode, skill-security-scanner) + export-import --repo/--branch#1276

Merged
tamirdresher merged 2 commits into
devfrom
docs/v010-remaining-feature-pages
Jun 14, 2026

Conversation

@tamirdresher

Copy link
Copy Markdown
Collaborator

What

Closes the remaining 8 (of 11) user-facing v0.10 features from #1272. Continuation of #1274 (preset, cross-squad, coordinator-as-agent).

New pages (8)

File Feature Source verified against
features/tiered-memory.md Hot/cold/wiki agent memory model (20-55% context reduction) packages/squad-cli/templates/skills/tiered-memory/SKILL.md
features/reflect.md In-session learning skill (HIGH/MED/LOW patterns) packages/squad-cli/templates/skills/reflect/SKILL.md
features/error-recovery.md 5 standard failure recovery patterns packages/squad-cli/templates/skills/error-recovery/SKILL.md
features/teams-comms.md Microsoft Teams comm adapter (PKCE / device code) packages/squad-sdk/src/platform/comms-teams.ts + changeset
features/fleet-dispatch.md /fleet hybrid dispatch mode for squad watch packages/squad-cli/src/cli/commands/watch/capabilities/fleet-dispatch.ts
features/mcp-frontmatter.md squad init --mcp-frontmatter flag packages/squad-cli/src/cli-entry.ts:346
features/dual-mode-deployment.md SQUAD_POD_ID + pod-specific capabilities packages/squad-sdk/src/ralph/capabilities.ts
features/skill-security-scanner.md Markdown-aware skill security scanner scripts/security-review.mjs + changeset

Edited (1)

File What changed
features/export-import.md Added --repo / --branch sections for both squad export and squad import

Why

#1272 identified that ~37% of v0.10 user-facing features had no dedicated docs. PR #1274 covered the top 3 priorities; this PR closes the remaining 8.

Source verification

Each page was written against the actual implementation:

  • Read each feature's source file before drafting
  • Verified flag names, environment variable names, default behaviors, and CLI surfaces
  • Cross-checked against the corresponding .changeset/<feature>.md description
  • No fabricated commands or inferred behavior

Push protection note

Initial push was blocked by GitHub Secret Scanning — the original skill-security-scanner.md used realistic-looking credential strings in the "What it catches" examples table. Amended the commit to use unambiguous placeholder syntax (<long-secret-token-value>, ghp_<40-character-token>, etc.) which the scanner ignores. The page still teaches users what kinds of strings would trip the scanner without containing matches itself.

Combined v0.10 docs coverage after merging

Status Before #1272 After #1274 After this PR
Documented 19 / 30 (63%) 22 / 30 (73%) 30 / 30 (100%) for the sampled set
Undocumented 11 8 0

Related

  • Closes #1272 (companion to #1274)
  • Companion issue: #1273 (root CHANGELOG.md staleness — separate concern)

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>
Copilot AI review requested due to automatic review settings June 11, 2026 15:22
@github-actions

github-actions Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

🛫 PR Readiness Check

ℹ️ This comment updates on each push. Last checked: commit 986a777

PR Scope: 🔧 Infrastructure

⚠️ 4 item(s) to address before review

Status Check Details
Single commit 2 commits — consider squashing before review
Not in draft Ready for review
Branch up to date dev is 15 commit(s) ahead — rebase recommended
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 30 unresolved Copilot thread(s) — fix and resolve before merging
CI passing All checks passing

Files Changed (10 files, +939 −1)

File +/−
cspell.json +3 −1
docs/src/content/docs/features/dual-mode-deployment.md +132 −0
docs/src/content/docs/features/error-recovery.md +95 −0
docs/src/content/docs/features/export-import.md +41 −0
docs/src/content/docs/features/fleet-dispatch.md +132 −0
docs/src/content/docs/features/mcp-frontmatter.md +102 −0
docs/src/content/docs/features/reflect.md +91 −0
docs/src/content/docs/features/skill-security-scanner.md +118 −0
docs/src/content/docs/features/teams-comms.md +127 −0
docs/src/content/docs/features/tiered-memory.md +98 −0

Total: +939 −1


This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.

@github-actions

github-actions Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

🟡 Impact Analysis — PR #1276

Risk tier: 🟡 MEDIUM

📊 Summary

Metric Count
Files changed 10
Files added 8
Files modified 2
Files deleted 0
Modules touched 2

🎯 Risk Factors

  • 10 files changed (6-20 → MEDIUM)
  • 2 modules touched (2-4 → MEDIUM)

📦 Modules Affected

docs (9 files)
  • docs/src/content/docs/features/dual-mode-deployment.md
  • docs/src/content/docs/features/error-recovery.md
  • docs/src/content/docs/features/export-import.md
  • docs/src/content/docs/features/fleet-dispatch.md
  • docs/src/content/docs/features/mcp-frontmatter.md
  • docs/src/content/docs/features/reflect.md
  • docs/src/content/docs/features/skill-security-scanner.md
  • docs/src/content/docs/features/teams-comms.md
  • docs/src/content/docs/features/tiered-memory.md
root (1 file)
  • cspell.json

This report is generated automatically for every PR. See #733 for details.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation pages intended to close the remaining v0.10 feature-doc gaps and updates the Export/Import docs to describe new repo/branch sync options.

Changes:

  • Added 8 new feature pages under docs/src/content/docs/features/ (tiered-memory, reflect, error-recovery, teams-comms, fleet-dispatch, mcp-frontmatter, dual-mode-deployment, skill-security-scanner).
  • Updated export-import.md with sections describing --repo / --branch flows for squad export and squad import.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 30 comments.

Show a summary per file
File Description
docs/src/content/docs/features/tiered-memory.md New Tiered Memory documentation page (hot/cold/wiki model).
docs/src/content/docs/features/reflect.md New Reflect skill documentation page (in-session learning capture).
docs/src/content/docs/features/error-recovery.md New Error Recovery skill documentation page (standard recovery patterns).
docs/src/content/docs/features/teams-comms.md New Microsoft Teams communication adapter documentation page.
docs/src/content/docs/features/fleet-dispatch.md New Fleet Dispatch documentation page for squad watch dispatchMode behavior.
docs/src/content/docs/features/mcp-frontmatter.md New docs page for squad init --mcp-frontmatter and MCP config placement.
docs/src/content/docs/features/dual-mode-deployment.md New docs page for pod-aware capability manifests and env vars.
docs/src/content/docs/features/skill-security-scanner.md New docs page describing a “skill security scanner” / security-review behavior.
docs/src/content/docs/features/export-import.md Expanded Export/Import docs with --repo / --branch sections.

Comment on lines +50 to +54
The export lands at the repo root as `squad-export.json` by default. Combine with `--out` to control the filename inside the repo:

```bash
squad export --repo myorg/squad-backups --out my-team-2026-06-11.json
```
Comment on lines +86 to +88
# Import a specific filename or branch
squad import --repo myorg/squad-backups --branch nightly
squad import --repo myorg/squad-backups --out my-team-2026-06-11.json
Comment on lines +91 to +94
Requirements:
- GitHub CLI (`gh`) installed and authenticated with read access to the source repo
- The export file must exist at the named path in the repo (default: `squad-export.json` at repo root)

Comment on lines +35 to +38
1. **Cached token** — looks for a previously-saved token in the OS credential store
2. **Refresh token** — if cached refresh token is valid, silently re-issues an access token
3. **Browser PKCE** — opens a browser for the user to sign in; uses Authorization Code with PKCE; 120-second timeout
4. **Device code** — fallback when no browser is available (CI, remote shell); user enters a code on a different device
Comment on lines +54 to +60
The adapter requires a Microsoft Entra (Azure AD) app registration with permissions for:

- `Chat.ReadWrite` (1:1 chat operations)
- `ChannelMessage.Send` (channel posts)
- `ChannelMessage.Read.All` (read channel replies)
- `User.Read` (basic profile)

Comment on lines +84 to +90
node scripts/security-review.mjs --scope skills

# Scan a single skill file
node scripts/security-review.mjs --file .copilot/skills/my-skill/SKILL.md

# JSON output for tooling integration
node scripts/security-review.mjs --scope skills --format json
Comment on lines +93 to +96
Exit codes:
- `0` — no findings
- `1` — findings detected (CI fails the build)
- `2` — scanner error (couldn't read file, malformed markdown, etc.)
## Caveats

- **The tier split is currently advisory** — the skill defines hot/cold/wiki semantics, but the spawn template doesn't yet enforce `--include-cold` / `--include-wiki` flags as part of the runtime contract. Adoption is per-team via spawn-template edits.
- **Wiki has no UI** — there's no `squad wiki list` command yet. Entries live as files in `.squad/wiki/` (when teams create that directory) and the coordinator references them by path.

- **No automatic pod discovery.** The SDK reads env vars to know who it is; it doesn't enumerate sibling pods or coordinate work distribution. That's the deployment orchestrator's job (KEDA, scheduler).
- **No central capability registry.** Pods don't publish their capabilities back to anything; each pod evaluates issues against its own loaded manifest independently. If you need a central view, your orchestrator must aggregate.
- **Manifest changes require redeploy or restart.** The fallback lookup happens on capability resolution; manifest content is read from disk each time but the manifest *path* is decided by env vars set at process start.
Comment on lines +63 to +64
6. The prompt is sent as a single `copilot --fleet` invocation
7. Copilot runs all tracks in parallel, posts comments per issue, exits

@bradygaster bradygaster left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Flight approves. Pure docs addition for v0.10 features. The docs-quality check fails on 'typoo' in error-recovery.md:79 — that appears to be an intentional typo used in the error-recovery demo. If not intentional, trivial fix.

…mple

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>
@tamirdresher tamirdresher merged commit f9f77c0 into dev Jun 14, 2026
14 checks passed
@tamirdresher tamirdresher deleted the docs/v010-remaining-feature-pages branch June 14, 2026 04:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: v0.10 feature coverage gap — 11 user-facing features have no dedicated documentation

4 participants