Skip to content

docs: Add architecture diagrams with Mermaid visualizations#7426

Open
darshjme wants to merge 2 commits intomicrosoft:mainfrom
darshjme:docs/architecture-diagrams
Open

docs: Add architecture diagrams with Mermaid visualizations#7426
darshjme wants to merge 2 commits intomicrosoft:mainfrom
darshjme:docs/architecture-diagrams

Conversation

@darshjme
Copy link
Copy Markdown

Summary

  • Adds visual architecture documentation with Mermaid diagrams to docs/design/
  • Covers standalone and distributed runtime architecture, agent type hierarchy, publish-subscribe message flow, AgentChat team execution, team pattern comparison, and worker protocol lifecycle
  • Updates docs/design/readme.md with a table of contents linking all design documents

Motivation

Visual diagrams significantly reduce onboarding time for new contributors and users trying to understand AutoGen's multi-agent architecture. The existing design documents (01 through 05) are text-only. This adds a companion visual reference using Mermaid, which renders natively on GitHub without external tooling.

Changes

  • docs/design/06 - Architecture Diagrams.md — new file with 6 Mermaid diagrams
  • docs/design/readme.md — added table of contents for all design docs
  • Documentation only, no code changes

Diagrams included

  1. Standalone Runtime — message router, subscription table, agent catalog
  2. Distributed Runtime — host servicer, gateway, worker processes
  3. Agent Type Hierarchy — class diagram from core Agent through AgentChat agents and teams
  4. Publish-Subscribe Message Flow — sequence diagram showing the code-generation example from the docs
  5. AgentChat Team Execution — sequence diagram of GroupChatManager orchestration loop
  6. Team Pattern Comparison — side-by-side of RoundRobin, Selector, Swarm, and GraphFlow
  7. Worker Protocol Lifecycle — state machine for worker-host communication phases

Add visual architecture documentation covering:
- Standalone and distributed runtime architecture
- Agent type hierarchy (core and AgentChat layers)
- Publish-subscribe message flow with sequence diagrams
- AgentChat team execution lifecycle
- Team pattern comparison (RoundRobin, Selector, Swarm, GraphFlow)
- Worker protocol state machine for distributed deployments

Update design docs readme with table of contents.
@darshjme
Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

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.

1 participant