docs: add architecture diagram for DevPost submission (#123)#131
Conversation
Generate architecture diagram showing: - Browser (Next.js 15 PWA) as pure renderer - Go Backend on Cloud Run with SessionManager, Live API Proxy, Tool Executor, and Onboarding Pipeline - 4 Gemini API models (Live, Pro, Flash, Imagen 4) - Google Cloud services (Firestore, Storage, YouTube Data API) - Data flow: WebSocket audio + tool calls + external services Source Mermaid file included for future updates. Closes #123 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary of ChangesHello @ComBba, 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 introduces comprehensive architectural documentation for the project, primarily for a DevPost submission. It provides a clear visual representation of the system's components, including the frontend, backend, AI models, and cloud services, and their interconnections. This enhancement aims to improve understanding of the system's design and functionality for external evaluators. Highlights
Changelog
Activity
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
|
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Code Review
This pull request adds a helpful architecture diagram, which is a great step for documenting the system. The diagram is largely accurate and provides a good overview of the components and their interactions. I've added a couple of suggestions to the Mermaid source file to enhance the accuracy of the connections between backend components and to clarify the progressive nature of the scene generation, making the diagram even more informative.
| WS --- SM | ||
| SM --- LP | ||
| LP --- TE | ||
| OP -.->|persona| SM |
There was a problem hiding this comment.
The connections within the Backend subgraph could be more accurate to better reflect the component interactions seen in the code. The current chained representation WS --- SM --- LP --- TE is a bit misleading.
Based on internal/handler/websocket.go, the WebSocket Handler (WS) creates and orchestrates the other main components. Also, the Onboarding Pipeline (OP) is invoked by the Tool Executor (TE) via a tool call, so a link between them would improve clarity.
Consider restructuring this block to show these relationships more clearly, for example:
WS --> SM
WS --> LP
LP --> TE
TE --> OP
OP -.->|persona| SM
| TE -->|generate_scene| FLASH | ||
| TE -->|generate_scene| IMAGEN |
There was a problem hiding this comment.
To improve clarity on the two-stage progressive image generation, consider making the labels for the generate_scene tool more specific. The current diagram shows two identical arrows, which doesn't fully convey that one is a quick preview and the other is the final, high-quality image.
Updating the labels will make the progressive nature of this feature more apparent.
TE -->|"generate_scene (preview)"| FLASH
TE -->|"generate_scene (final)"| IMAGEN
Summary
docs/architecture.pngusing Mermaiddocs/architecture.mmdfor future updatesIssue
Closes #123
Local CI
Test plan
docs/architecture.pngin GitHub to verify renderingREADME.mdimage tag:<img src="docs/architecture.png">🤖 Generated with Claude Code