docs: Clarify GitHub Copilot requirement and BYOK status#385
Closed
diberry wants to merge 33 commits intobradygaster:devfrom
Closed
docs: Clarify GitHub Copilot requirement and BYOK status#385diberry wants to merge 33 commits intobradygaster:devfrom
diberry wants to merge 33 commits intobradygaster:devfrom
Conversation
Add 4 new docs pages and update 3 existing: - New: five-minute-start.md (5-minute quickstart) - New: architecture.md (how Squad works) - New: choosing-your-path.md (CLI vs SDK vs Copilot) - New: glossary.md (key terms reference) - Update: troubleshooting.md (common errors table) - Update: first-session.md (jargon definitions) - Update: navigation.ts (sidebar entries) Closes bradygaster#301 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Root cause: four independent issues combined into a scroll storm: 1. Ink fullscreen clearTerminal path firing every render cycle 2. ~16 unsynchronized animation re-renders/sec from 3 timers 3. Unstable Static component keys causing Ink remounts 4. Layout shift from height toggling between processing states Changes: - Patch Ink fullscreen path (disable clearTerminal, incrementalRendering, trailing newline) - Widen spinner/animation intervals (80->150ms spinner, 500->800ms pulse) - Share terminal dimension hook with 150ms debounce - Pin root height to prevent logUpdate cursor drift - Keep conversation in live viewport (not Static scrollback) - Stable UUID-based Static keys, responsive maxVisible - Fix bump-build.mjs to produce valid semver prerelease format - Fix marketplace test for Windows path compat Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
fix(cli): eliminate terminal scroll flicker and rerender storm
Closes bradygaster#343 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…cs-5 Docs update: comprehensive new-user experience improvements
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Reverts .squad/agents/pao/history.md to upstream/main so it no longer appears in the PR diff. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Session: 2026-03-10-adoption-tracking Requested by: Scribe Changes: - Merged 4 decisions from inbox to decisions.md: adoption tracking 3-tier architecture, implementation, append-only governance, ampersand style guide - Updated Flight and EECOM history.md with team cross-agent updates - Created orchestration logs for PAO (PR bradygaster#303 rebase), Flight (adoption proposal), EECOM (Tier 1 implementation) - Created session log documenting adoption tracking architecture finalization - Deleted decision inbox files after merge
New docs pages derived from public blog post analysis: - scenarios/ralph-operations.md: outer loop deployment, mutex, logging, alerting - scenarios/proactive-communication.md: two-way Teams webhooks and scanning - features/issue-templates.md: squad-aware issue templates, routing labels - features/reviewer-protocol.md: trust levels section (full/selective/self-managing) - test/docs-build.test.ts: assertions updated for new pages All content follows Microsoft Style Guide. No individual repo names — aggregate references only per owner privacy directive. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Remove ralph-operations.md and proactive-communication.md — both document infrastructure around Squad (webhooks, WorkIQ, deployment patterns) rather than Squad itself. Content moves to Squad IRL repo. Reframe issue-templates.md to clarify GitHub Issue Templates are a platform feature configured for Squad routing, not a Squad feature. Litmus test applied: if Squad doesn't ship the code/config, it belongs in IRL. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Created comprehensive documentation for working across GitHub personal
accounts and GitHub Enterprise Managed Users (EMU):
- New scenario page: scenarios/cross-org-auth.md
- Three solution approaches: gh auth switch, Copilot instructions,
Squad skill pattern
- Git credential helper configuration
- Common error messages and verification steps
- Updated troubleshooting.md with cross-org auth section
- Updated enterprise-platforms.md authentication section with cross-ref
- Added navigation entry for Cross-Org Auth scenario
- Updated test assertions in docs-build.test.ts
Follows Microsoft Style Guide (sentence-case headings, active voice).
Includes practical examples and cross-references to related pages.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Fixed test assertion arrays to match actual files on disk: - EXPECTED_SCENARIOS: expanded from 7 to 25 entries - EXPECTED_FEATURES: added new array with 32 entries This resolves the sync issue identified in PR bradygaster#331 review where test assertions were out of sync with docs/src/content/docs/ structure. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…ntent triage, remote access proposal Session: 2026-03-11T01-27-57-post-work-orchestration Agents: FIDO (Quality Owner), Flight (Lead) Changes: - Orchestration logs for FIDO (test assertion sync fix, commit 6599db6) and Flight (content triage skill) - Merged 6 decisions from inbox to decisions.md - Consolidated boundary heuristic: "Squad Ships It" (docs vs IRL) across content-triage skill and PR bradygaster#331 review - Added content-triage workflow for external content integration - Added phased rollout proposal for remote Squad access (Discussions → Copilot → Chat) - Added PR trust levels spectrum (full/selective/self-managing) - Cross-agent updates: FIDO, Flight, PAO history.md sync; boundary heuristic shared Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds a mandatory scannability framework for all content reviews: - Paragraphs: narrative flow, conceptual explanations (3-4 sentences max) - Bullet lists: features, options, scannable items (parallel structure) - Tables: comparisons, structured reference data, attribute grids - Quotes/indents: warnings, callouts, cited material - Decision test: hunt-for-one-item = convert to bullets/table PAO applies this on every PR with documentation impact. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The coordinator's Acknowledge Immediately section now requires a task context signal (Continuing/New task/Related pivot) before naming agents. This helps users understand whether the system recognizes their message as part of ongoing work or a fresh request. Closes bradygaster#359 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
When prior conversation history exists, the ThinkingIndicator cycles through context-aware phrases (e.g. 'Reviewing conversation context', 'Connecting to previous work') instead of generic ones. This gives users immediate feedback that the system recognizes ongoing conversation. - Add CONVERSATION_PHRASES array to ThinkingIndicator - Add hasConversation prop threaded through App -> MessageStream -> ThinkingIndicator - Derive hasConversation from messages array in App.tsx (true when agent responses exist) Closes bradygaster#360 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds a background update check that runs when the interactive shell starts. On startup, Squad checks the npm registry for a newer version and displays a passive notification banner if one is available. Key design decisions: - Fire-and-forget: never blocks or delays shell startup - 24-hour cache: avoids repeated network calls - 3-second fetch timeout via AbortController - Opt-out via SQUAD_NO_UPDATE_CHECK=1 env var - Triple-wrapped error handling: silent on any failure New file: packages/squad-cli/src/cli/self-update.ts Modified: packages/squad-cli/src/cli-entry.ts (wired into no-args shell path) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add prominent recommendation to use copilot --yolo in step 4 of the Quick Start guide. Squad sessions involve many tool calls, so --yolo provides a smoother experience by skipping individual approval prompts. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Bump minimatch 9.0.6→9.0.9 (ReDoS: GHSA-7r86-cg39-jmmj, GHSA-23c5-xmqv-rm74) - Bump rollup 4.58.0→4.59.0 (path traversal: GHSA-mw96-cpmx-2vgc) - Add --name to squad aspire Docker command to prevent unnamed orphan containers - Align test and CLI on shared container name (squad-aspire-dashboard) - Add SIGINT/SIGTERM/exit handlers to aspire integration test for cleanup Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Resolve workspace packages to source in vitest so vi.mock intercepts correctly. Without this, npm ci installs a duplicate squad-sdk under squad-cli/node_modules which bypasses the mock.
…t-coordinator-prompt feat: add task context classification to coordinator acknowledgment
…nd-docker-cleanup fix: resolve npm audit vulnerabilities and Aspire Docker test cleanup
…ommendation docs: recommend --yolo in README Quick Start
…se-roles feat: add 20 built-in base roles for faster team casting
…rtup-check feat: non-blocking version check on CLI startup (Phase 1)
…n-aware-thinking-indicator feat: conversation-aware thinking phrases in ThinkingIndicator
…y-guidance docs(pao): add SCANNABILITY REVIEW hard rule to PAO charter
…sonal-squad-path-docs-v2 fix(docs): replace ~/.squad/ with platform-specific path references
…xplainer docs: scenario and feature guides from blog analysis
…merged Session: 2026-03-14T14-40-47Z-copilot-requirement-docs Requested by: Copilot (Dina Berry) Changes: - Created orchestration log for PAO spawn (Issue bradygaster#323 resolution) - Created session log documenting Copilot requirement clarification - Merged inbox decision (Copilot-only backend, BYOK not supported) - Deleted processed inbox file - Propagated team update to Flight history
Closes bradygaster#323 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
force-pushed
the
squad/323-clarify-copilot-requirement
branch
from
6e8a264 to
c454c53
Compare
tamirdresher
pushed a commit
to tamirdresher/squad
that referenced
this pull request
Mar 16, 2026
…radygaster#408) * chore(squad): Phase 2 launch — thinking feedback, P0 bugs, dual telemetry Phase 1 complete: 5 issues closed (bradygaster#325, bradygaster#326, bradygaster#327, bradygaster#328, bradygaster#329), 5 PRs merged. Phase 2 launched with Cheritto (thinking feedback), Hockney (P0 bugs), Saul (dual telemetry). Decision inbox merged and archived. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore(squad): Phase 2 Wave 1 merged, Wave 2 launched Session: 2026-02-23T2145-phase2-wave2 Phase 2 Wave 1 complete (PRs bradygaster#351, bradygaster#352, bradygaster#353 merged). Wave 2 launched: Cheritto on ghost response detection (bradygaster#332), Hockney on error hardening (bradygaster#334). Changes: - Session log created: 2026-02-23T2145-phase2-wave2.md - Merged 3 inbox decisions (Cheritto, Hockney, Saul) - Deleted inbox files post-merge Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore(squad): Epic bradygaster#323 complete — all phases shipped 🎉 All 3 phases delivered: - Phase 1 (Testing Wave): 6 issues closed - Phase 2 (Improvement): 6 issues closed - Phase 3 (Breathtaking): 7 issues closed - 17 PRs merged, 19 issues closed total Session log: 2026-02-23T2320-epic-complete.md Decisions merged from inbox: P2 UX Polish, first-run wow moment Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * hostile QA: end-to-end quality assessment — 10 findings, 4 HIGH severity Candid assessment requested by Brady. Traced every code path in cli-entry.ts, shell/index.ts, shell/commands.ts, App.tsx, coordinator.ts, spawn.ts, and the SDK adapter client. Key findings: - Dead sessions never evicted from agentSessions Map after connection drop - No React ErrorBoundary — any render throw kills the shell - Nasty-inputs corpus (95 strings) is never imported by any test - No SIGTERM handler in interactive shell - MemoryManager exported but never instantiated (dead code) - Single streaming content slot clobbers multi-agent output - User input silently dropped during processing (no type-ahead buffer) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore(squad): quality review findings — 7 issues filed Quality audit complete: 5 agents assessed CLI across testing, coverage, stability, accessibility, UX. Results: 4 P0 blockers (bradygaster#365–bradygaster#368), 3 P1 items (bradygaster#369–bradygaster#371). Blocking: Waingro dead sessions, ErrorBoundary, dropped input; Marquez help text consistency. Changes: - Logged session summary to .squad/log/2026-02-24T0205-quality-review-complete.md - Updated .squad/identity/now.md with quality review findings and new issue numbers Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore(squad): merge decision — Marquez UX audit findings Quality assessment merged from inbox (Grade B): 11 improvements (3 P0, 4 P1, 4 P2). help text, stub commands, vocabulary, separators, roster. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * chore(squad): test sprint launch Session: 2026-02-24T0210-test-sprint Changes: - Logged test sprint: 5 agents, 7+ issues - Branches: P0 fixes, stale tests, E2E, hostile/SDK, A11y Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * test: add human journey E2E tests for 7 real user scenarios Test the actual human experience, not internal modules. Each describe block maps to a filed GitHub issue and simulates what a real person does when they encounter Squad for the first time and beyond. Journeys tested (39 assertions): 1. I just installed this — squad init creates .squad/, shows ceremony, gives clear next step, writes first-run marker, exits cleanly 2. My first conversation — welcome banner shows agent roster with names/roles/emojis, project description, focus area, first-run ceremony is one-time only 3. I'm waiting and getting anxious — ThinkingIndicator appears immediately, shows elapsed time, activity hints override default, NO_COLOR mode works 4. Something went wrong — friendly error messages with remediation tips, no stack traces leaked, whitespace input handled gracefully 5. I want to talk to a specific agent — @agent routing, case- insensitive matching, comma syntax, unknown names fall to coordinator 6. I'm a power user now — /help, /status, /agents, /history, /quit all return useful output, unknown commands guide to /help 7. I came back the next day — state persists, first-run consumed, team still loaded, focus area survives between sessions Closes bradygaster#383, bradygaster#384, bradygaster#385, bradygaster#386, bradygaster#394, bradygaster#396, bradygaster#398 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Copy polish: warmer, human-centered messages across CLI Every message now feels helpful, not corporate. Changes include: - cli-entry.ts: 'Your AI team, always ready' instead of generic desc - commands.ts: Status output changed from 'Root/Active now' to 'Home/Active' - Help text: 'Check your team' instead of 'Show which squad' - InputPrompt: 'Message or @agent' instead of corporate placeholder - App.tsx: 'Your team is assembled. Let's try:' (warmer tone) - init.ts: 'Your team is assembled' instead of 'ready' - ThinkingIndicator: Dynamic thinking phrases (Processing, Working) - All command help: Casual verbs (Who's here, Fresh screen, Leave) Tests updated to match new output strings. All 125+ CLI tests pass. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
tamirdresher
pushed a commit
to tamirdresher/squad
that referenced
this pull request
Mar 16, 2026
… (bradygaster#484) * test: human journey — Power user (bradygaster#396) Add E2E journey test covering advanced shell features: - /help and /status slash commands - Tab completion for /commands and @agent names - Ctrl+C cancel during processing - Double Ctrl+C exit - Multiple slash commands in sequence - @agent direct routing with complex messages Closes bradygaster#396 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * test: human journey — I'm waiting and getting anxious (bradygaster#385) Add E2E journey test covering the user experience while waiting for agent responses: thinking indicators, phase labels, activity hints, streaming content updates, /status visibility, Ctrl+C cancellation, and recovery after cancel. 14 test cases validate the full anxiety-to-reassurance path. Closes bradygaster#385 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.
Closes #323
What
Clarifies that GitHub Copilot is the only supported LLM backend. BYOK is not a supported feature.
Changes
Working as PAO (DevRel)
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com