Skip to content

docs: architecture diagrams with Mermaid#12

Closed
diberry wants to merge 9 commits intodevfrom
squad/pao-arch-diagram
Closed

docs: architecture diagrams with Mermaid#12
diberry wants to merge 9 commits intodevfrom
squad/pao-arch-diagram

Conversation

@diberry
Copy link
Copy Markdown
Owner

@diberry diberry commented Mar 24, 2026

PAO: Architecture Diagrams

What's here

7 Mermaid diagrams covering Squad's architecture:

  1. User interaction flow — how a person interacts with Squad
  2. Component architecture — Coordinator, agents, Scribe, Ralph
  3. State management — decisions, history, orchestration log
  4. Parallel execution — fan-out pattern, background agents
  5. Casting system — universe selection, name allocation
  6. Decision flow — drop-box pattern, Scribe merge
  7. Worktree lifecycle — branch isolation, cleanup

All diagrams in Mermaid source format at docs/src/content/docs/concepts/architecture.md.

Status

Ready for review. See also: PNG rendering PR and CI proposal PR.

Copilot AI added 5 commits March 22, 2026 05:42
- Orchestration log: 2026-03-22T12-36Z-pao.md — PAO completed full docs catalog audit
- Session log: 2026-03-22T12-36Z-docs-catalog-audit.md — session summary
- Merged .squad/decisions/inbox/pao-docs-audit.md into decisions.md
- Updated PAO history.md with docs audit learnings (15 orphans, 0 dead links, 5 top actions)
- Deleted inbox file
- Docs audit found critical nav gaps, stale content, duplication; formalized 5 action items

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Orchestration: Booster completed whatsnew.md version sync automation (2026-03-22T12:46Z)
- Merged decision: whatsnew auto-sync via prebuild script + Vitest test gate
- Updated PAO history: Docs audit finding #1 (stale version) resolved
- Removed merged inbox decision: booster-whatsnew-sync.md

whatsnew.md heading now syncs on every build (local + CI), keeping release docs current with package.json version.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Orchestration log: 2026-03-22T12-55Z-pao.md (PAO DevRel spawn)
- Session log: 2026-03-22T12-55Z-docs-fixes.md
- Inbox: clean (no files to merge)

All 4 fires resolved. Build tests passing (23/23).
# Conflicts:
#	docs/src/content/docs/guide.md
#	docs/src/content/docs/tips-and-tricks.md
#	docs/src/content/docs/tour-first-session.md
Copilot AI added 4 commits March 24, 2026 07:11
- Added User Interaction Flow (sequence diagram) showing how messages flow through Squad
- Added Component Architecture (layered flowchart) showing UI, orchestration, execution, state, persistence, and artifact layers
- Added State Management (drop-box pattern) showing parallel agent writes to inbox and Scribe merging
- Added Parallel Execution Model showing background fan-out, sync, and review gate modes
- Added Casting & Persistent Naming showing how agents maintain identity across sessions and repos
- Added Decision & Knowledge Flow (sequence diagram) showing how directives, decisions, and memory compound
- Included descriptive text under each diagram explaining key concepts
- All diagrams use Mermaid syntax with color coding by concern
- Organized for 30-second comprehension by first-time readers

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add comprehensive 7th Mermaid diagram showing git worktree lifecycle, including:
- Trigger (issue assignment)
- Worktree setup and reuse
- Parallel agent work with shared worktree
- Commit and PR flow
- State merging via union driver
- Cleanup

Includes comparison of worktree-local vs main-checkout strategies with detailed steps.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry
Copy link
Copy Markdown
Owner Author

diberry commented Mar 27, 2026

Superseded by PR #11 (TypeDoc API reference).

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.

2 participants