docs: comprehensive docs overhaul — truth, voice, and organization#1426
docs: comprehensive docs overhaul — truth, voice, and organization#1426bradygaster wants to merge 1 commit into
Conversation
- Delete retired docs (personal-squad, remote-control, shell, REPL blog) - Remove experimental/alpha warnings from all docs - Remove all personal squad references across 11 files - Voice pass: augmentation over replacement language (~30 files) - Remove REPL/interactive shell references (~45 files) - Reorganize navigation: Core/Advanced/Infrastructure feature tiers - Fix CI test knownSections for new nav structure - Fix broken internal links to deleted pages Closes #1194 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
🔴 Impact Analysis — PR #1426Risk tier: 🔴 CRITICAL 📊 Summary
🎯 Risk Factors
📦 Modules Affecteddocs (133 files)
This report is generated automatically for every PR. See #733 for details. |
🏗️ Architectural Review
Automated architectural review — informational only. |
🛫 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 | No Copilot review threads |
| ❌ | CI passing | 1 check(s) failing: docs-quality |
Files Changed (133 files, +1715 −10907)
| File | +/− |
|---|---|
docs/src/content/blog/001-wave-0-the-team-that-built-itself.md |
+0 −22 |
docs/src/content/blog/001a-the-squad-squad-problem.md |
+4 −29 |
docs/src/content/blog/001b-meet-the-squad.md |
+0 −35 |
docs/src/content/blog/001c-first-pr-amolchanov.md |
+0 −24 |
docs/src/content/blog/002-first-community-pr.md |
+0 −19 |
docs/src/content/blog/003-super-bowl-weekend.md |
+0 −19 |
docs/src/content/blog/004-v020-release.md |
+0 −28 |
docs/src/content/blog/005-v030-give-it-a-brain.md |
+0 −33 |
docs/src/content/blog/006-first-external-deployment.md |
+0 −28 |
docs/src/content/blog/007-first-video-coverage.md |
+0 −24 |
docs/src/content/blog/008-v040-release.md |
+1 −27 |
docs/src/content/blog/009-v040-sprint-progress.md |
+0 −48 |
docs/src/content/blog/010-v041-patch-release.md |
+0 −17 |
docs/src/content/blog/011-skills-system-learning-from-work.md |
+0 −74 |
docs/src/content/blog/012-trending-on-github.md |
+0 −32 |
docs/src/content/blog/013-the-replatform-begins.md |
+0 −27 |
docs/src/content/blog/014-wave-1-otel-and-aspire.md |
+0 −31 |
docs/src/content/blog/015-wave-2-the-repl-moment.md |
+0 −95 |
docs/src/content/blog/016-wave-3-docs-that-teach.md |
+0 −28 |
docs/src/content/blog/017-version-alignment.md |
+0 −29 |
docs/src/content/blog/018-the-adapter-chronicles.md |
+0 −34 |
docs/src/content/blog/019-shaynes-remote-mode.md |
+0 −33 |
docs/src/content/blog/020-docs-reborn.md |
+0 −36 |
docs/src/content/blog/021-the-migration.md |
+0 −70 |
docs/src/content/blog/022-welcome-to-the-new-squad.md |
+16 −257 |
docs/src/content/blog/024-v0823-release.md |
+1 −194 |
docs/src/content/blog/026-whats-new-ado-comms-subsquads.md |
+0 −42 |
docs/src/content/blog/027-v0825-release.md |
+0 −25 |
docs/src/content/blog/028-new-docs-site.md |
+0 −40 |
docs/src/content/blog/028-v090-whats-new.md |
+15 −130 |
docs/src/content/blog/029-upgrade-testing-at-scale.md |
+1 −45 |
docs/src/content/blog/030-v092-whats-coming.md |
+0 −52 |
docs/src/content/blog/031-state-backends.md |
+1 −34 |
docs/src/content/blog/watch-monitor.md |
+5 −50 |
docs/src/content/docs/concepts/architecture.md |
+45 −71 |
docs/src/content/docs/concepts/github-workflow.md |
+1 −90 |
docs/src/content/docs/concepts/memory-and-knowledge.md |
+0 −97 |
docs/src/content/docs/concepts/parallel-work.md |
+3 −117 |
docs/src/content/docs/concepts/portability.md |
+0 −109 |
docs/src/content/docs/concepts/your-team.md |
+2 −113 |
docs/src/content/docs/cookbook/recipes.md |
+1 −89 |
docs/src/content/docs/features/capability-routing.md |
+50 −76 |
docs/src/content/docs/features/ceremonies.md |
+0 −48 |
docs/src/content/docs/features/cleanup.md |
+0 −51 |
docs/src/content/docs/features/consult-mode.md |
+18 −104 |
docs/src/content/docs/features/context-hygiene.md |
+84 −130 |
docs/src/content/docs/features/coordinator-as-agent-export.md |
+0 −69 |
docs/src/content/docs/features/copilot-coding-agent.md |
+5 −85 |
docs/src/content/docs/features/copilot-mcp-trust.md |
+0 −33 |
docs/src/content/docs/features/cost-tracking.md |
+63 −89 |
| ... | +83 more files |
Total: +1715 −10907
This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.
tamirdresher
left a comment
There was a problem hiding this comment.
Nice cleanup — the retired content removal and voice pass look great.
One small suggestion: in the "Try this:" quick-start block at the top of installation.md, consider changing bare squad to squad --version as the first thing to run after install. Running bare squad launches the full interactive experience which can be disorienting for someone who just wants to confirm the install worked. The Verify section further down already says squad --version — making the top block consistent would help first-timers.
Summary
Complete documentation overhaul addressing accuracy, voice/tone, organization, and open issues. Every doc and blog post was audited against the 0.11.0 codebase.
Changes
Retired Features Removed
guide/personal-squad.md(feature retired)features/remote-control.md(deprecatedsquad start)guide/shell.md(REPL deprioritized)blog/015-wave-2-the-repl-moment.md(REPL blog)Experimental Warnings Removed
⚠️ Experimental — alpha softwarefrom 122 filesVoice Pass — Augmentation Over Replacement
Navigation Reorganization
docs/tests/build-output.test.mjsknownSectionsIssue Fixes
.squad/config.jsononly)Write a PRD for…) but spec only supports ingestion #1186 — PRD Mode rewritten as ingestion/analysis (not authoring).squad/ralph-instructions.mdis an undocumented escape hatch insquad watch --execute— document it or remove it #1314 — Documented.squad/ralph-instructions.mdescape hatchBroken Links Fixed
remote-control.md→squad-rc.mdCloses
Closes #1194, closes #1400, closes #1264, closes #1186, closes #1314