Skip to content

docs: centralize CLI and interface guidance#399

Closed
diberry wants to merge 1 commit intobradygaster:devfrom
diberry:squad/398-choose-your-interface
Closed

docs: centralize CLI and interface guidance#399
diberry wants to merge 1 commit intobradygaster:devfrom
diberry:squad/398-choose-your-interface

Conversation

@diberry
Copy link
Copy Markdown
Collaborator

@diberry diberry commented Mar 14, 2026

Summary

Centralizes "which CLI / which mode" documentation in a single page addressing community feedback from issue #398.

Changes

  • New page: docs/src/content/docs/get-started/choose-your-interface.md
    • Complete breakdown of all Squad interfaces (GitHub Copilot CLI, VS Code, Squad CLI, Interactive Shell, SDK, Copilot Coding Agent)
    • Clear decision tree table
    • Feature availability matrix
    • Common workflows section
  • Updated existing pages:
    • installation.md — added link to the new page
    • guide.md — replaced scattered CLI guidance with concise summary + link
    • client-compatibility.md — added callout at top linking to the new page
  • Test updates: Added choose-your-interface to expected docs pages in est/docs-build.test.ts

Why

Issue #398 (from @jmservera) revealed users are confused about:

  • When to use Squad CLI vs GitHub Copilot CLI
  • What the different "modes" of Squad are
  • Which features are available where

Content was scattered across multiple files (guide.md, cli.md, installation.md, client-compatibility.md, blog post 028) with some contradictions.

Testing

  • ✅ All docs tests pass (
    pm test -- docs-build.test.ts)
  • ✅ New page builds correctly in Astro
  • ✅ Links resolve properly
  • ✅ Microsoft Style Guide compliance (sentence-case headings, active voice, present tense)

Related

Partial fix for #398

cc @jmservera — this should help clear up the confusion about which interface to use!

- Add 'Choose your interface' page covering all Squad interfaces
- Link from installation, guide, and client-compatibility pages
- Update docs test assertions for new page

Partial fix for bradygaster#398

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry
Copy link
Copy Markdown
Collaborator Author

diberry commented Mar 14, 2026

Consolidated into PR #389 — all changes from this PR have been merged into the consolidated docs quality PR.

@diberry diberry closed this Mar 14, 2026
bradygaster pushed a commit that referenced this pull request Mar 15, 2026
Merges diberry's consolidated docs PR #389.
Closes #258, Fixes #351, Addresses #197 item 6, Addresses #398.
19 files, -1,471 net lines. Bloat reduction across guide.md, tips-and-tricks.md, sample-prompts.md, and more.
Supersedes PRs #390, #391, #392, #395, #397, #399.
tamirdresher pushed a commit to tamirdresher/squad that referenced this pull request Mar 16, 2026
* 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#365bradygaster#368), 3 P1 items (bradygaster#369bradygaster#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>

* test: add speed gate tests for impatient user journey

18 speed gate tests enforcing time budgets across the user journey:
- Help scanability, init ceremony speed, welcome data loading
- Input parsing latency, ghost retry bounds, error actionability
- Version output speed and format

Filed issues: bradygaster#387, bradygaster#395, bradygaster#397, bradygaster#399, bradygaster#401, bradygaster#403

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
…gaster#439)

* 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#365bradygaster#368), 3 P1 items (bradygaster#369bradygaster#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>

* Fix bradygaster#423/bradygaster#399: Remove welcome typewriter animation blocking

Users can now type immediately when shell launches. Removed 500ms typewriter
animation and 300ms fade-in from welcome banner — title and content appear
instantly.

Pattern: instant feedback beats cosmetic delay. Matches bradygaster#427 shell loading fix.

Closes bradygaster#423
Closes bradygaster#399

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Update Cheritto history: bradygaster#423 welcome animation fix

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

2 participants