Skip to content

docs: add installation method decision tree#288

Open
diberry wants to merge 1 commit intobradygaster:mainfrom
diberry:squad/new-customer-docs-2
Open

docs: add installation method decision tree#288
diberry wants to merge 1 commit intobradygaster:mainfrom
diberry:squad/new-customer-docs-2

Conversation

@diberry
Copy link

@diberry diberry commented Mar 8, 2026

What this PR does

Adds a 'Which method should I use?' decision table to the Installation Guide, helping new users choose between the four installation methods based on their goals.

Changes

Goal Recommended Method Why
Try Squad quickly CLI (npx) Zero install, instant start
Use Squad regularly CLI (global) Available everywhere, faster startup
Stay in your editor VS Code extension Inline AI assistance while coding
Build programmatically SDK (npm package) Full API access for custom workflows

Includes a fallback recommendation for undecided users: Start with the CLI.

Context

This addresses a gap identified in new-user experience testing: after the installation overview, users weren't sure which of the three methods to pick. The decision table provides quick guidance without requiring users to read all three sections.

Closes #287

Suggested reviewers: @diberry, @bradygaster

Adds a 'Which method should I use?' decision table to the installation guide,
helping new users choose between CLI (npx/global), VS Code extension, and SDK
based on their goals.

Closes bradygaster#287

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

diberry commented Mar 8, 2026

@bradygaster — PR is ready for review. Adds a decision table to the installation guide helping new users pick the right install method.

1 similar comment
@diberry
Copy link
Author

diberry commented Mar 8, 2026

@bradygaster — PR is ready for review. Adds a decision table to the installation guide helping new users pick the right install method.

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: Add installation method decision tree

1 participant