docs: expand CLI README (3.1x) and docs site reference (40+ commands)#487
Merged
bradygaster merged 1 commit intobradygaster:devfrom Mar 22, 2026
Merged
Conversation
- README: expanded from 77 to 236 lines (3.1x) - Added installation, quick start, command reference tables - Added .squad/ directory structure guide - Added configuration and troubleshooting sections - Applied Microsoft Writing Style Guide - docs/reference/cli.md: expanded from 354 to 608 lines - Command coverage: 16 to 40+ commands documented - Added 6 common workflow sequences - Organized into 9 logical sections - Added dual-root mode explanation - markdownlint passes clean Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Collaborator
Author
|
@bradygaster — Docs-only PR. CLI README went from 77 to 236 lines, docs site CLI reference from 16 to 40+ commands. No code changes. markdownlint clean. |
bradygaster
approved these changes
Mar 22, 2026
Owner
bradygaster
left a comment
bradygaster
left a comment
There was a problem hiding this comment.
PAO review: Docs expansion looks thorough and well-organized. 40+ commands documented with workflows. Fixed broken docs link (getting-started → get-started). Rebased on dev. Ready to merge.
chrislomonico
pushed a commit
to clomonico/squad
that referenced
this pull request
Mar 26, 2026
Session: 2026-02-24-wave-d-kickoff Requested by: Brady Changes: - Logged orchestration for Hockney (PR bradygaster#487), Keaton (issues bradygaster#488–bradygaster#493), Fenster (timeout fix) - Created session log for Wave D kickoff with summary and next steps - Merged Wave D readiness assessment from inbox into decisions.md - Notified Cheritto, Kovash, Fortier of Wave D Batch 1 assignments via history.md updates - Cross-agent updates: Cheritto assigned P1 UX items (bradygaster#488–bradygaster#490), Kovash P2 hardening (bradygaster#491–bradygaster#492), Fortier streamBuffer cleanup (bradygaster#493) 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.
docs: expand CLI README and docs site reference
No code changes — pure documentation improvements based on a team code review of
packages/squad-cli.CLI README (
packages/squad-cli/README.md)Before: 77 lines — too brief for a 40+ command CLI.
After: 236 lines (3.1x) with:
.squad/directory structure explanationsquad doctor, common issues)Docs site CLI reference (
docs/src/content/docs/reference/cli.md)Before: 354 lines, 16 commands listed in a flat table.
After: 608 lines with:
CI