Skip to content

docs: architecture diagrams as PNG with collapsed Mermaid source#13

Closed
diberry wants to merge 7 commits intodevfrom
squad/pao-arch-docs
Closed

docs: architecture diagrams as PNG with collapsed Mermaid source#13
diberry wants to merge 7 commits intodevfrom
squad/pao-arch-docs

Conversation

@diberry
Copy link
Copy Markdown
Owner

@diberry diberry commented Mar 24, 2026

PAO: Rendered Architecture Diagrams

What's here

  • 7 PNG renders of architecture diagrams (via mmdc/Mermaid CLI)
  • Architecture docs page with images + collapsed Mermaid source blocks
  • Located at docs/src/content/docs/concepts/

Depends on

Status

Ready for review. See also: CI Mermaid rendering proposal.

Copilot AI added 7 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
Convert all 7 Mermaid diagrams from the architecture page to optimized PNG images:
- User Interaction Flow (sequence diagram)
- Component Architecture (layered system)
- State Management (drop-box pattern)
- Parallel Execution Model (execution modes)
- Casting & Persistent Naming (agent identity)
- Decision & Knowledge Flow (full cycle)
- Git Worktree Lifecycle (branch isolation)

Updated architecture.md with PNG image references and collapsed Mermaid source blocks for each diagram. Added comprehensive intro explaining Squad's orchestration model and knowledge persistence across sessions.

Diagrams render in docs site while source blocks allow readers to copy and adapt Mermaid code.

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).

@diberry diberry closed this Mar 27, 2026
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