Reformat architecture diagram in README#64
Conversation
Summary of ChangesHello @ewiner, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the clarity of the project's documentation by reformatting the ASCII architecture diagram within the Highlights
Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request reformats the ASCII architecture diagram in the README.md file, improving its alignment and readability. The change is a good improvement. I've added a suggestion to consider replacing the ASCII art with a Mermaid diagram in the future to make it easier to maintain.
| ┌────────────────────────────────────────────────────────────────┐ | ||
| │ Channels │ | ||
| │ ┌──────┐ ┌──────┐ ┌─────────────┐ ┌─────────────┐ │ | ||
| │ │ REPL │ │ HTTP │ │WASM Channels│ │ Web Gateway │ │ | ||
| │ └──┬───┘ └──┬───┘ └──────┬──────┘ │ (SSE + WS) │ │ | ||
| │ │ │ │ └──────┬──────┘ │ | ||
| │ └─────────┴──────────────┴────────────────┘ │ | ||
| │ │ │ | ||
| │ ┌─────────▼─────────┐ │ | ||
| │ │ Agent Loop │ Intent routing │ | ||
| │ └────┬──────────┬───┘ │ | ||
| │ │ │ │ | ||
| │ ┌──────────▼────┐ ┌──▼───────────────┐ │ | ||
| │ │ Scheduler │ │ Routines Engine │ │ | ||
| │ │(parallel jobs)│ │(cron, event, wh) │ │ | ||
| │ └──────┬────────┘ └────────┬─────────┘ │ | ||
| │ │ │ │ | ||
| │ ┌─────────────┼────────────────────┘ │ | ||
| │ │ │ │ | ||
| │ ┌───▼─────┐ ┌────▼────────────────┐ │ | ||
| │ │ Local │ │ Orchestrator │ │ | ||
| │ │Workers │ │ ┌───────────────┐ │ │ | ||
| │ │(in-proc)│ │ │ Docker Sandbox│ │ │ | ||
| │ └───┬─────┘ │ │ Containers │ │ │ | ||
| │ │ │ │ ┌───────────┐ │ │ │ | ||
| │ │ │ │ │Worker / CC│ │ │ │ | ||
| │ │ │ │ └───────────┘ │ │ │ | ||
| │ │ │ └───────────────┘ │ │ | ||
| │ │ └─────────┬───────────┘ │ | ||
| │ └──────────────────┤ │ | ||
| │ │ │ | ||
| │ ┌───────────▼──────────┐ │ | ||
| │ │ Tool Registry │ │ | ||
| │ │ Built-in, MCP, WASM │ │ | ||
| │ └──────────────────────┘ │ | ||
| └────────────────────────────────────────────────────────────────┘ |
There was a problem hiding this comment.
Thanks for reformatting the architecture diagram. The alignment is much better now.
For future maintenance, consider replacing the ASCII art with a Mermaid diagram. GitHub renders Mermaid diagrams directly in Markdown, which makes them much easier to edit and keep up-to-date than ASCII art.
Here's a possible Mermaid version of the current diagram:
graph TD
subgraph "Channels"
A[REPL]
B[HTTP]
C[WASM Channels]
D[Web Gateway <br/> (SSE + WS)]
end
E[Agent Loop <br/> Intent routing]
A & B & C & D --> E
F[Scheduler <br/> (parallel jobs)]
G[Routines Engine <br/> (cron, event, wh)]
E --> F
E --> G
subgraph "Execution"
H[Local Workers <br/> (in-proc)]
I[Orchestrator]
end
%% Invisible node for merging
M1((( )))
style M1 fill:none,stroke:none
F --> M1
G --> M1
M1 --> H
M1 --> I
subgraph "Docker Sandbox"
J[Containers]
K[Worker / CC]
J --> K
end
I --> J
L[Tool Registry <br/> (Built-in, MCP, WASM)]
H --> L
I --> L
To use this, you would replace the ASCII art block with this Mermaid block, ensuring the language identifier is mermaid.
A whitespace-only change to fix up the ASCII diagram.