Skip to content

docs: comprehensive docs overhaul — truth, voice, and organization#1426

Open
bradygaster wants to merge 1 commit into
devfrom
bradygaster-squad-docs-audit-and-refresh
Open

docs: comprehensive docs overhaul — truth, voice, and organization#1426
bradygaster wants to merge 1 commit into
devfrom
bradygaster-squad-docs-audit-and-refresh

Conversation

@bradygaster

Copy link
Copy Markdown
Owner

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

  • Deleted guide/personal-squad.md (feature retired)
  • Deleted features/remote-control.md (deprecated squad start)
  • Deleted guide/shell.md (REPL deprioritized)
  • Deleted blog/015-wave-2-the-repl-moment.md (REPL blog)
  • Scrubbed all personal squad references from 11 files
  • Removed REPL/shell references from ~45 files

Experimental Warnings Removed

  • Removed ⚠️ Experimental — alpha software from 122 files
  • Only insider-only features should carry experimental banners going forward

Voice Pass — Augmentation Over Replacement

  • Replaced "hire/fire" with "add/release/cast" (~30 files)
  • Replaced "autonomous/unattended" with "guided/background/async"
  • Replaced "does the work for you" with "moves the work forward"
  • Aligned with David Pine's philosophy: AI amplifies humans, doesn't replace them

Navigation Reorganization

  • Get Started: Trimmed from 5 → 3 items (essentials only)
  • Concepts: Moved up to position 2 (understand before doing)
  • Features: Split 30-item wall into Core (13) / Advanced (16) / Infrastructure (8)
  • Guides: Absorbed Cookbook, added missing entries
  • Scenarios: Reordered simple → complex
  • Updated docs/tests/build-output.test.mjs knownSections

Issue Fixes

Broken Links Fixed

  • Redirected links to deleted remote-control.mdsquad-rc.md

Closes

Closes #1194, closes #1400, closes #1264, closes #1186, closes #1314

- 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>
Copilot AI review requested due to automatic review settings June 30, 2026 17:03
@github-actions

Copy link
Copy Markdown
Contributor

🔴 Impact Analysis — PR #1426

Risk tier: 🔴 CRITICAL

📊 Summary

Metric Count
Files changed 133
Files added 0
Files modified 129
Files deleted 4
Modules touched 1

🎯 Risk Factors

  • 133 files changed (>50 → CRITICAL)
  • 1 module(s) touched (≤1 → LOW)
  • 4 file(s) deleted

📦 Modules Affected

docs (133 files)
  • docs/src/content/blog/001-wave-0-the-team-that-built-itself.md
  • docs/src/content/blog/001a-the-squad-squad-problem.md
  • docs/src/content/blog/001b-meet-the-squad.md
  • docs/src/content/blog/001c-first-pr-amolchanov.md
  • docs/src/content/blog/002-first-community-pr.md
  • docs/src/content/blog/003-super-bowl-weekend.md
  • docs/src/content/blog/004-v020-release.md
  • docs/src/content/blog/005-v030-give-it-a-brain.md
  • docs/src/content/blog/006-first-external-deployment.md
  • docs/src/content/blog/007-first-video-coverage.md
  • docs/src/content/blog/008-v040-release.md
  • docs/src/content/blog/009-v040-sprint-progress.md
  • docs/src/content/blog/010-v041-patch-release.md
  • docs/src/content/blog/011-skills-system-learning-from-work.md
  • docs/src/content/blog/012-trending-on-github.md
  • docs/src/content/blog/013-the-replatform-begins.md
  • docs/src/content/blog/014-wave-1-otel-and-aspire.md
  • docs/src/content/blog/015-wave-2-the-repl-moment.md
  • docs/src/content/blog/016-wave-3-docs-that-teach.md
  • docs/src/content/blog/017-version-alignment.md
  • docs/src/content/blog/018-the-adapter-chronicles.md
  • docs/src/content/blog/019-shaynes-remote-mode.md
  • docs/src/content/blog/020-docs-reborn.md
  • docs/src/content/blog/021-the-migration.md
  • docs/src/content/blog/022-welcome-to-the-new-squad.md
  • docs/src/content/blog/024-v0823-release.md
  • docs/src/content/blog/026-whats-new-ado-comms-subsquads.md
  • docs/src/content/blog/027-v0825-release.md
  • docs/src/content/blog/028-new-docs-site.md
  • docs/src/content/blog/028-v090-whats-new.md
  • docs/src/content/blog/029-upgrade-testing-at-scale.md
  • docs/src/content/blog/030-v092-whats-coming.md
  • docs/src/content/blog/031-state-backends.md
  • docs/src/content/blog/watch-monitor.md
  • docs/src/content/docs/concepts/architecture.md
  • docs/src/content/docs/concepts/github-workflow.md
  • docs/src/content/docs/concepts/memory-and-knowledge.md
  • docs/src/content/docs/concepts/parallel-work.md
  • docs/src/content/docs/concepts/portability.md
  • docs/src/content/docs/concepts/your-team.md
  • docs/src/content/docs/cookbook/recipes.md
  • docs/src/content/docs/features/capability-routing.md
  • docs/src/content/docs/features/ceremonies.md
  • docs/src/content/docs/features/cleanup.md
  • docs/src/content/docs/features/consult-mode.md
  • docs/src/content/docs/features/context-hygiene.md
  • docs/src/content/docs/features/coordinator-as-agent-export.md
  • docs/src/content/docs/features/copilot-coding-agent.md
  • docs/src/content/docs/features/copilot-mcp-trust.md
  • docs/src/content/docs/features/cost-tracking.md
  • docs/src/content/docs/features/cross-squad-discover.md
  • docs/src/content/docs/features/directives.md
  • docs/src/content/docs/features/distributed-mesh.md
  • docs/src/content/docs/features/dual-mode-deployment.md
  • docs/src/content/docs/features/error-recovery.md
  • docs/src/content/docs/features/export-import.md
  • docs/src/content/docs/features/external-state.md
  • docs/src/content/docs/features/fleet-dispatch.md
  • docs/src/content/docs/features/github-issues.md
  • docs/src/content/docs/features/human-team-members.md
  • docs/src/content/docs/features/issue-templates.md
  • docs/src/content/docs/features/keda-scaling.md
  • docs/src/content/docs/features/labels.md
  • docs/src/content/docs/features/loop.md
  • docs/src/content/docs/features/marketplace.md
  • docs/src/content/docs/features/mcp-frontmatter.md
  • docs/src/content/docs/features/mcp.md
  • docs/src/content/docs/features/memory.md
  • docs/src/content/docs/features/model-selection.md
  • docs/src/content/docs/features/notification-level.md
  • docs/src/content/docs/features/notifications.md
  • docs/src/content/docs/features/parallel-execution.md
  • docs/src/content/docs/features/plugins.md
  • docs/src/content/docs/features/prd-mode.md
  • docs/src/content/docs/features/preset.md
  • docs/src/content/docs/features/project-boards.md
  • docs/src/content/docs/features/ralph.md
  • docs/src/content/docs/features/rate-limiting.md
  • docs/src/content/docs/features/reflect.md
  • docs/src/content/docs/features/remote-control.md
  • docs/src/content/docs/features/response-modes.md
  • docs/src/content/docs/features/reviewer-protocol.md
  • docs/src/content/docs/features/routing.md
  • docs/src/content/docs/features/scratch-dir.md
  • docs/src/content/docs/features/self-upgrade.md
  • docs/src/content/docs/features/skill-security-scanner.md
  • docs/src/content/docs/features/skills.md
  • docs/src/content/docs/features/squad-rc.md
  • docs/src/content/docs/features/state-backends.md
  • docs/src/content/docs/features/storage-provider.md
  • docs/src/content/docs/features/team-setup.md
  • docs/src/content/docs/features/teams-comms.md
  • docs/src/content/docs/features/tiered-memory.md
  • docs/src/content/docs/features/upstream-inheritance.md
  • docs/src/content/docs/features/vscode.md
  • docs/src/content/docs/features/worktrees.md
  • docs/src/content/docs/get-started/choose-your-interface.md
  • docs/src/content/docs/get-started/choosing-your-path.md
  • docs/src/content/docs/get-started/first-session.md
  • docs/src/content/docs/get-started/five-minute-start.md
  • docs/src/content/docs/get-started/installation.md
  • docs/src/content/docs/guide.md
  • docs/src/content/docs/guide/build-autonomous-agent.md
  • docs/src/content/docs/guide/building-extensions.md
  • docs/src/content/docs/guide/extensibility.md
  • docs/src/content/docs/guide/faq.md
  • docs/src/content/docs/guide/personal-squad.md
  • docs/src/content/docs/guide/sample-prompts.md
  • docs/src/content/docs/guide/shell.md
  • docs/src/content/docs/guide/tips-and-tricks.md
  • docs/src/content/docs/reference/api-reference.md
  • docs/src/content/docs/reference/cli.md
  • docs/src/content/docs/reference/config.md
  • docs/src/content/docs/reference/glossary.md
  • docs/src/content/docs/reference/integration.md
  • docs/src/content/docs/reference/sdk.md
  • docs/src/content/docs/reference/tools-and-hooks.md
  • docs/src/content/docs/reference/vscode-troubleshooting.md
  • docs/src/content/docs/scenarios/aspire-dashboard.md
  • docs/src/content/docs/scenarios/ci-cd-integration.md
  • docs/src/content/docs/scenarios/existing-repo.md
  • docs/src/content/docs/scenarios/issue-driven-dev.md
  • docs/src/content/docs/scenarios/monorepo.md
  • docs/src/content/docs/scenarios/new-project.md
  • docs/src/content/docs/scenarios/open-source.md
  • docs/src/content/docs/scenarios/remote-qa.md
  • docs/src/content/docs/scenarios/solo-dev.md
  • docs/src/content/docs/scenarios/team-of-humans.md
  • docs/src/content/docs/scenarios/team-state-storage.md
  • docs/src/content/docs/tour-first-session.md
  • docs/src/content/docs/whatsnew.md
  • docs/src/navigation.ts
  • docs/tests/build-output.test.mjs

This report is generated automatically for every PR. See #733 for details.

@github-actions

Copy link
Copy Markdown
Contributor

🏗️ Architectural Review

⚠️ Architectural review: 1 warning(s).

Severity Category Finding Files
🟡 warning sweeping-refactor This PR touches 133 files (129 modified/added, 4 deleted). Large PRs are harder to review — consider splitting if possible.

Automated architectural review — informational only.

@github-actions

github-actions Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

🛫 PR Readiness Check

ℹ️ This comment updates on each push. Last checked: commit 3778e5a

PR Scope: 🔧 Infrastructure

⚠️ 2 item(s) to address before review

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.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review this pull request because it exceeds the maximum number of lines (20,000). Try reducing the number of changed lines and requesting a review from Copilot again.

@tamirdresher tamirdresher left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@github-actions

Copy link
Copy Markdown
Contributor

👋 Friendly nudge — this PR has had no activity for 7 days.

What needs attention:

  • 🔴 1 CI check(s) failing: docs-quality. Fix these first.
  • 👀 No approving reviews yet. Request a review from a teammate.

If this PR is abandoned, please close it. If it's blocked on something external, leave a comment so the team knows.
This is an automated check that runs on weekdays. It won't nudge the same PR more than once per week.

@tamirdresher

Copy link
Copy Markdown
Collaborator

@bradygaster — following up on this PR's current state:

  • Merge state: CONFLICTING against dev (last touched July 10).
  • Size: 133 files, +1,715 / −10,907. Too large for meaningful per-line review — the impact bot flags it CRITICAL.
  • Overlap with merged work: docs: align external-state page with actual externalize/internalize behavior #1466 merged today and rewrites docs/src/content/docs/features/external-state.md, which this PR also overhauls. docs/src/content/blog/006-first-external-deployment.md is in scope for both as well.

How would you like to proceed? Two directions that would both unblock review — no preference from me, just want your steer:

  1. Split into focused PRs — e.g. (a) retired-doc deletions, (b) REPL cleanup, (c) voice/terminology sweep, (d) per-issue content fixes. Each one reviewable per-line and mergeable quickly.
  2. Rebase and keep as one owner-driven overhaul — resolve the docs: align external-state page with actual externalize/internalize behavior #1466 overlap, refresh against dev, and we treat it as a coordinated docs release rather than a line-level review.

Whichever you pick, happy to help move it forward.

@github-actions

Copy link
Copy Markdown
Contributor

👋 Friendly nudge — this PR has had no activity for 7 days.

What needs attention:

  • 🔴 1 CI check(s) failing: docs-quality. Fix these first.
  • 👀 No approving reviews yet. Request a review from a teammate.
  • ⬇️ 33 commits behind dev. Rebase to pick up latest changes.

If this PR is abandoned, please close it. If it's blocked on something external, leave a comment so the team knows.
This is an automated check that runs on weekdays. It won't nudge the same PR more than once per week.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment