Repository navigation
docs: get-started cleanup — installation fix, squad init, interface canonical (WS-D) - #1573
Merged
Merged
Conversation
Contributor
🟡 Impact Analysis — PR #1573Risk tier: 🟡 MEDIUM 📊 Summary
🎯 Risk Factors
📦 Modules Affecteddocs (6 files)
This report is generated automatically for every PR. See #733 for details. |
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 | 4 unresolved Copilot thread(s) — fix and resolve before merging |
| ✅ | CI passing | All checks passing |
Files Changed (6 files, +190 −574)
| File | +/− |
|---|---|
docs/src/content/docs/get-started/choose-your-interface.md |
+120 −178 |
docs/src/content/docs/get-started/choosing-your-path.md |
+0 −82 |
docs/src/content/docs/get-started/first-session.md |
+4 −85 |
docs/src/content/docs/get-started/five-minute-start.md |
+58 −87 |
docs/src/content/docs/get-started/installation.md |
+7 −142 |
docs/src/navigation.ts |
+1 −0 |
Total: +190 −574
This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR cleans up the Get Started docs to remove retired “bare squad”/REPL artifacts, consolidates interface guidance, and aligns the docs navigation + build-output assertions with the updated section structure (WS-D follow-on to the WS-B nav restructure).
Changes:
- Fixes Get Started command snippets to use
squad --version/squad initinstead of baresquad. - Consolidates “choose a mode/interface” content by deleting
choosing-your-path.mdand updatingchoose-your-interface.md. - Updates
docs/src/navigation.tsanddocs/tests/build-output.test.mjsto reflect the new nav/section taxonomy.
Show a summary per file
| File | Description |
|---|---|
| docs/tests/build-output.test.mjs | Updates the expected Pagefind “section” values to match the new nav section titles. |
| docs/src/navigation.ts | Restructures nav sections (Concepts promoted; Features split; Guides updated; Scenarios reordered). |
| docs/src/content/docs/get-started/installation.md | Updates install verification command and trims/simplifies troubleshooting + setup guidance. |
| docs/src/content/docs/get-started/five-minute-start.md | Removes experimental banner and refines quick start wording/structure. |
| docs/src/content/docs/get-started/first-session.md | Replaces bare squad with squad init in walkthrough code blocks. |
| docs/src/content/docs/get-started/choosing-your-path.md | Deletes the page as part of consolidation. |
| docs/src/content/docs/get-started/choose-your-interface.md | Removes deprecated REPL/interface sections and updates the comparison/positioning content. |
Review details
Suppressed comments (2)
docs/src/navigation.ts:94
- This section mixes slugs from other top-level dirs (
get-started/*,cookbook/*) into theGuidessection. Because Pagefind section metadata is derived from the slug’s first path segment (seeDocsLayout.astro), these pages will still be indexed under Get Started or the fallback Docs, not Guides—so sidebar grouping and search section facets will disagree.
items: [
{ title: 'Choose Your Interface', slug: 'get-started/choose-your-interface' },
{ title: 'Tips & Tricks', slug: 'guide/tips-and-tricks' },
{ title: 'Sample Prompts', slug: 'guide/sample-prompts' },
{ title: 'Recipes', slug: 'cookbook/recipes' },
docs/src/navigation.ts:121
Migration Guideis placed under theScenariosnav section, but its slug isget-started/migration. With the current section-metadata logic (slug prefix → section), this page will still be indexed as Get Started, not Scenarios, which makes nav grouping and search facets inconsistent.
{ title: 'Migration Guide', slug: 'get-started/migration' },
- Files reviewed: 7/7 changed files
- Comments generated: 5
- Review effort level: Lite
|
|
||
| Squad works in VS Code through GitHub Copilot. Your `.squad/` directory works identically in both CLI and VS Code — same agents, same decisions, same memory. | ||
|
|
||
| > **Tip:** Initialize your team with the CLI (`squad`), then open the project in VS Code to keep working with the same squad. |
|
|
||
| --- | ||
| ## Prerequisites | ||
| - **Node.js 20+** — Check with `node --version` |
Comment on lines
+52
to
+54
| title: 'Advanced Features', | ||
| dir: 'features', | ||
| items: [ |
| ```bash | ||
| copilot --agent squad | ||
| ``` | ||
| Reads `.squad/` and uses `squad.agent.md` to coordinate your team. Full feature set — sub-agent spawning, per-spawn model selection, background execution, SQL tools, parallel fan-out. |
Comment on lines
+99
to
106
| Your npm global bin isn't in your PATH. Fix: | ||
| ```bash | ||
| # Check if installed | ||
| npm list -g @bradygaster/squad-cli | ||
| # If installed but not found, check PATH: | ||
| echo $PATH | grep npm # macOS/Linux | ||
| echo %PATH% | findstr npm # Windows | ||
| ``` |
…erface canonical (WS-D) - Fix installation.md 'Try this:' block: bare 'squad' → 'squad --version' (addresses tamirdresher review comment from #1426) - Fix first-session.md: bare 'squad' → 'squad init' in all Try this and step code blocks (REPL-era artifact) - Remove⚠️ Experimental banners from all get-started files - Remove deprecated Interactive shell/REPL sections from choose-your-interface.md - Delete choosing-your-path.md (no inbound links; content covered by choose-your-interface.md) - Add choose-your-interface.md to Guides nav section - Apply WS-B nav restructure (depends on squad/1426-b-concepts-nav merging first) Supersedes part of #1426 Working as PAO (DevRel) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
bradygaster
force-pushed
the
squad/1426-d-get-started
branch
from
August 3, 2026 01:57
407e5b6 to
ec8498c
Compare
This was referenced Aug 3, 2026
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.
Summary
Get-started page cleanup addressing tamirdresher's review comment from #1426, first-session REPL regression fix, and page consolidation. This is WS-D of the four-part #1426 replacement strategy.
docs/src/navigation.tsanddocs/tests/build-output.test.mjsto include the WS-B restructure plus one addition. Mergesquad/1426-b-concepts-nav(PR #1571) before this PR to avoid a navigation.ts conflict, or rebase this branch on merged dev after WS-B lands.File Scope
docs/src/content/docs/get-started/installation.mdsquad→squad --versiondocs/src/content/docs/get-started/first-session.mdsquad→squad init(REPL artifact)docs/src/content/docs/get-started/five-minute-start.mddocs/src/content/docs/get-started/choose-your-interface.mddocs/src/content/docs/get-started/choosing-your-path.mddocs/src/navigation.tsdocs/tests/build-output.test.mjsChanges Applied
installation.md — tamirdresher's fix
The
## Try this:block previously showed baresquadas the post-install verification. The## Verifysection further down already showedsquad --version. Now consistent throughout.Before:
After:
first-session.md — REPL regression fix
All bare
squad(no subcommand) in code blocks replaced withsquad init. The baresquadcommand was the interactive REPL entrypoint, which has been retired. Without this fix, new users following the guide would run a command that either prints help text or does nothing.Page consolidation
choosing-your-path.mddeleted — no inbound links confirmed; the 3-mode decision content overlapped withchoose-your-interface.mdchoose-your-interface.mdadded to Guides nav section as the canonical mode-comparison pageValidation
npm run buildindocs/: ✅ passesgrep -n '^squad$' docs/src/content/docs/get-started/*.md→ 0 matches ✅grep 'squad --version' installation.md→ appears in Try this block ✅grep 'squad init' first-session.md→ present ✅Reviewer Note
This PR resolves tamirdresher's unresolved review thread on #1426 (2026-07-03, installation quick-start bare
squadcommand).Supersedes part of #1426
Working as PAO (DevRel)