docs: consolidated docs quality, reduction, and dedup#389
Merged
bradygaster merged 13 commits intobradygaster:devfrom Mar 15, 2026
Merged
docs: consolidated docs quality, reduction, and dedup#389bradygaster merged 13 commits intobradygaster:devfrom
bradygaster merged 13 commits intobradygaster:devfrom
Conversation
Collaborator
Author
|
@bradygaster This is deduplication only |
diberry
force-pushed
the
squad/docs-reduction-refinement
branch
from
35f14bc to
7570c1f
Compare
diberry
changed the title
This was referenced Mar 14, 2026
Collaborator
Author
✅ Full Team Review Complete — Ready for MergeThe entire squad reviewed PR #389 across 3 rounds and all reviewers now approve. Review Summary
Issues Found & Fixed (3 rounds)Round 1 (6 fixes):
Round 2 (2 fixes):
Round 3: Clean — zero issues found across all 9 changed docs files. PR Scope
|
Owner
…setup - Shorten 8 guide.md sections to intro + link (detail lives on feature pages) - Trim Ralph and Memory sections in tips-and-tricks.md - Replace duplicated MCP config blocks with links to canonical mcp.md - Replace duplicated notification setup with links to notifications.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- sample-prompts.md: 659->305 lines (-54%), removed feature showcase sections duplicating tips-and-tricks - sdk-first-mode.md: 659->517 lines (-22%), consolidated type defs into reference table - upstream-inheritance.md: 533->288 lines (-46%), merged 6 scenarios into 3 - release-process.md: 437->246 lines (-44%), compressed verbose prose to tables/bullets - mcp.md: 333->300 lines (-10%), deduplicated MCP definition and config blocks All copy-paste-ready content preserved. Cross-links added to canonical sources. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds a hard rule requiring PAO to search for existing coverage before writing new content, link to canonical pages instead of duplicating, and flag duplication during reviews. Prevents unnecessary docs growth. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Require anchor/fragment links when a more specific section exists, rather than linking to just the page URL. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Replace duplicated 3-step flow, triggers table, and config reference with a single cross-link to the canonical Notifications Guide. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…er#351 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Add local (--save-dev) and npx alternatives alongside global install - Update Node.js version requirement from 18 to 20 (matches package.json) - Replace hardcoded @0.8.18 version pins with @latest Closes bradygaster#197 (item 6 — docs scope only) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Removed broken reference to microsoft/IF-MCP-Server-for-Microsoft-Teams (it's actually a Court Listener demo, not a general Teams MCP server) - Clarified that path/to/*.js placeholders require actual MCP server implementations - Added link to community reference implementation (benleane83's teams-webhook-mcp.js gist) - Updated all MCP config examples to use /absolute/path/to/ format for clarity - Simplified Teams setup to focus on webhook approach (fastest, most practical) - Updated iMessage MCP server link to point to marketplace search instead of specific (potentially dead) link Closes bradygaster#258 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- 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>
…ion, README link Fixes from team review (PAO + FIDO): - guide.md: remove H1 anchors from response-modes and memory links - tips-and-tricks.md: same memory.md anchor fix - notifications.md: title case -> sentence case heading - docs-build.test.ts: add migration to EXPECTED_GET_STARTED - README.md: fix sdk-first-mode.md path Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- migration.md: sdk/ -> ../reference/sdk.md - sample-prompts.md: /tips-and-tricks -> tips-and-tricks.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Replaces bare 'copilot --yolo' with 'copilot --agent squad --yolo' to show the recommended startup command with the agent flag. Simplifies the VS Code instruction line. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds a clear comparison of what gets compacted vs what persists permanently in Squad's memory system. Helps users understand where to store knowledge that must survive compaction cycles. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
force-pushed
the
squad/docs-reduction-refinement
branch
from
78a5828 to
9cfb35a
Compare
Collaborator
Author
|
@bradygaster Ready for your review — docs reduction and refinement across 19 files. CI is green. — squad obo dina |
tamirdresher
pushed a commit
to tamirdresher/squad
that referenced
this pull request
Mar 16, 2026
…radygaster#413) * 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#365–bradygaster#368), 3 P1 items (bradygaster#369–bradygaster#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: visual polish — separators, help, status, agents, thinking indicator - Replace ASCII hyphens with box-drawing chars (U+2500) in AgentPanel and MessageStream separators for visual consistency - Restructure /help with section headers, column alignment, shortcuts - Redesign /status with brand mark and clean key-value layout - Replace /agents bracket notation ([IDLE]) with emoji + status words - Fix ThinkingIndicator double-dim making text nearly invisible - Add 'quit' to bare-word exit (matches /quit behavior) - Update tests to match new output format Closes bradygaster#388, bradygaster#389, bradygaster#390, bradygaster#391, bradygaster#392, bradygaster#393 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: update Marquez history with visual polish session 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
…x chars Fixes bradygaster#400 - /clear now sends ANSI escape codes to actually clear terminal screen Fixes bradygaster#389 - Recognize 'quit' and 'q' as exit words (not just 'exit') Fixes bradygaster#417 - Root CLI detects .squad/ existence and auto-launches shell or suggests init Fixes bradygaster#391 - Use proper Unicode box-drawing characters (─) with graceful ASCII fallback Changes: - commands.ts: Send \x1B[2J\x1B[H on /clear to truly clear the terminal - App.tsx: Expand EXIT_WORDS to include 'quit' and 'q' - cli-entry.ts: Check for .squad/ before defaulting to shell, show helpful init prompt if missing - AgentPanel.tsx + MessageStream.tsx: Use boxChars() for separators instead of hardcoded '─' All changes preserve cross-platform compatibility and respect NO_COLOR/terminal capabilities. Co-authored-by: bradygaster <brady@github.com>
tamirdresher
pushed a commit
to tamirdresher/squad
that referenced
this pull request
Mar 16, 2026
…atch-1 Reviewed by Keaton (Lead). Fixes bradygaster#400, bradygaster#389, bradygaster#417, bradygaster#391.
tamirdresher
pushed a commit
to tamirdresher/squad
that referenced
this pull request
Mar 16, 2026
Session: 2026-02-24T0430-prs-merged Requested by: Brady Changes: - Merged 6 decision inbox files into decisions.md (Cheritto, Fenster, Kovash, Marquez, McManus, Waingro) - Deleted all inbox files (now empty) - Created .squad/identity/prd-next-waves.md (4-wave execution plan: A=Polish, B=Reliability, C=Testing, D=Delight) - Updated .squad/identity/now.md to reflect Wave A focus - Created session log: .squad/log/2026-02-24T0430-prs-merged.md PRs merged this session: bradygaster#444, bradygaster#445, bradygaster#446, bradygaster#447 Issues closed: bradygaster#400, bradygaster#389, bradygaster#417, bradygaster#391, bradygaster#402, bradygaster#405, bradygaster#404, bradygaster#407, bradygaster#431, bradygaster#429 Issues filed: bradygaster#448-bradygaster#459 (Wave A Polish items) Process directive: All work through PRs with squad member review before merge 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.
Consolidated docs quality & reduction PR
Merges 7 content PRs into one to simplify review. Addresses the full PAO docs audit (redundancy, bloat, dedup, gaps).
Closes #258, Fixes #351, Addresses #197 item 6, Addresses #398
What changed (19 files, -1,471 net lines)
Bloat reduction (Phase 1 complete)
Deduplication
github-workflow.md: notification setup replaced with cross-links to notifications.md (was PR docs: dedup notification setup in github-workflow.md #392)mcp.md: consolidated duplicate config blocks, single MCP definition (was PR docs: audit and refresh Teams MCP integration docs #390)notifications.md: refreshed Teams MCP integration (was PR docs: audit and refresh Teams MCP integration docs #390)New & updated pages
get-started/choose-your-interface.md: centralized CLI/interface guidance (was PR docs: centralize CLI and interface guidance #399)get-started/migration.md: added local + npx install paths (was PR docs: add local and npx install paths to migration guide #397)get-started/installation.md: added cross-linksscenarios/client-compatibility.md: added cross-linksREADME.md: fixed migration guide link (was PR docs: fix remaining README migration guide link #395)Team governance
PAO charter: added CONTENT DISCIPLINE hard rule (was PR docs(pao): add CONTENT DISCIPLINE hard rule to charter #391)portability.md: minor refreshTest updates
test/docs-build.test.ts: updated expected page count for new choose-your-interface pageTraceability — what was removed and where it lives
Supersedes these PRs