Skip to content

docs: FAQ and CLI guidance improvements (#398)#403

Merged
bradygaster merged 3 commits intodevfrom
squad/398-docs-faq-cli-guidance
Mar 15, 2026
Merged

docs: FAQ and CLI guidance improvements (#398)#403
bradygaster merged 3 commits intodevfrom
squad/398-docs-faq-cli-guidance

Conversation

@bradygaster
Copy link
Copy Markdown
Owner

Closes #398 — Addresses community feedback from @jmservera on FAQ and CLI documentation gaps

What changed:

  • Created comprehensive FAQ page (docs/guide/faq.md) covering all four feedback items
  • Added platform callouts to Aspire dashboard and Copilot coding agent docs
  • Clarified which CLI to use in the product guide
  • Added troubleshooting section to CLI reference for squad doctor warnings
  • Updated test assertions to include new FAQ page

Community feedback addressed:
✅ Why gh issue edit --add-assignee @copilot does not work locally
✅ When to use Squad CLI vs GitHub Copilot CLI
✅ Aspire dashboard is Squad CLI only (added callout)
✅ squad doctor absolute path warning (added troubleshooting)

Working as PAO (DevRel) — following Microsoft Style Guide and DOCS-TEST SYNC pattern

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

@bradygaster
Copy link
Copy Markdown
Owner Author

FIDO Quality Review — ✅ APPROVED

Test discipline:

  • ✅ EXPECTED_GUIDES correctly updated to include 'faq' (7 items, matches disk)
  • ✅ Test passes: docs-build.test.ts validates all guide files present
  • ✅ DOCS-TEST SYNC rule followed

Content quality:

  • ✅ All internal links verified (client-compatibility.md, copilot-coding-agent.md, aspire-dashboard.md, team-setup.md, gitlab-issues.md, disaster-recovery.md)
  • ✅ Content accurate: CLI usage guidance correct, FAQ answers align with actual Squad behavior
  • ✅ Consistent cross-references between guide.md and faq.md

Structural:

  • ✅ Markdown syntax valid
  • ✅ No broken links
  • ✅ 277 lines of actionable FAQ content

CI failure:
The build failure is a pre-existing issue on dev branch, not introduced by this PR.

Verdict: ✅ GO — PAO maintained test assertions correctly. Safe to merge when dev CI is fixed.

bradygaster and others added 3 commits March 15, 2026 04:29
Session: 2026-03-15T11-27-09Z-team-sync
Requested by: Scribe

Changes:
- Logged team sync session (Flight triage + FIDO quality review)
- Archived 2 decisions from 2025-07 (>30 days old)
- Merged 2 orchestration logs
- No duplicates detected in decisions.md
- Test baseline: 3931 tests passing; 2 PRs ready to merge
Addresses community feedback from @jmservera on documentation gaps:

- Created comprehensive FAQ page covering:
  - Which CLI to use (GHCP CLI vs Squad CLI)
  - Bot assignment troubleshooting
  - Aspire dashboard Squad CLI requirement
  - squad doctor teamRoot absolute path warning
  - Common questions about setup and workflows

- Added platform callouts:
  - Aspire dashboard: noted Squad CLI requirement at top
  - Copilot coding agent: added troubleshooting note for bot assignment
  - CLI reference: added troubleshooting section for squad doctor warnings

- Clarified CLI guidance in guide.md:
  - Positioned GitHub Copilot CLI as recommended for day-to-day work
  - Positioned Squad CLI for setup and operations
  - Added common workflow pattern example

- Updated test assertions for new FAQ page

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bradygaster bradygaster force-pushed the squad/398-docs-faq-cli-guidance branch from d7e0c88 to 916130c Compare March 15, 2026 11:32
@bradygaster bradygaster merged commit 6315f38 into dev Mar 15, 2026
1 check failed
@bradygaster bradygaster deleted the squad/398-docs-faq-cli-guidance branch March 15, 2026 11:32
bradygaster added a commit that referenced this pull request Mar 15, 2026
Session: 2026-03-15T11-40-00Z-skill-install-and-flicker-fix
Requested by: Coordinator

Changes:
- Appended team updates to Flight history: bug classification (6 issues, 2 fixed)
- Appended team updates to PAO history: PR #403 merge (docs FAQ)
- Created INCO history: terminal flicker fix cherry-pick to dev (PR #405)
- Logged session activity for Flight, PAO, INCO, Coordinator

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
bradygaster added a commit that referenced this pull request Mar 15, 2026
… next sprint queued

Updated focus to irritating bugs sprint (#197, #353, #354).
Recorded PR merges (#404, #403, #405), flicker fix cherry-pick,
github-multi-account skill install, and pending PR status.

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
* 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
…aster#403) (bradygaster#461)

The triage command is a real implementation (not a stub) that polls issues
and auto-triages them to team members. Updated help text from 'Scan issues
and categorize' to 'Watch issues and auto-triage to team' for accuracy.

loop and hire commands were never implemented as stubs — they don't exist
in the codebase, only in decision docs as future ideas.

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.

1 participant