docs: add comprehensive architecture guide#28
Conversation
hoangsonww
commented
Mar 21, 2026
- Add ARCHITECTURE.md detailing 7-layer system design, data flows, deployment, and extension points
- Update README to link to architecture guide in Table of Contents and deployment section
- Remove badge section comments for cleaner badge display
- Minor formatting improvements for clarity
- Update release workflow to trigger on tags (v*) and generate release notes
…hitecture references - Add ARCHITECTURE.md detailing 7-layer system design, data flows, deployment, and extension points - Update README to link to architecture guide in Table of Contents and deployment section - Remove badge section comments for cleaner badge display - Minor formatting improvements for clarity - Update release workflow to trigger on tags (v*) and generate release notes
Summary of ChangesHello, 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 a detailed architecture guide for the Agentic Multi-Stage Bot, providing a clear understanding of the system's design and deployment. It also improves the README and release workflow for better maintainability and user experience. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Ignored Files
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. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive architecture guide in ARCHITECTURE.md, detailing the system's 7-layer design, data flows, and deployment. The README.md is also updated to link to this new guide and has had some formatting improvements. The new documentation is excellent and very thorough. I've included one minor suggestion to improve the accuracy of the entity-relationship diagram within the new architecture guide.
| CHAT ||--o{ MESSAGE : contains | ||
| CHAT ||--o{ FEEDBACK : receives | ||
| MESSAGE ||--o| FEEDBACK : "rated by" | ||
| KB_DOCUMENT ||--o{ KB_METADATA : has |
There was a problem hiding this comment.
The entity relationships in the Mermaid erDiagram could be more precise. The current notation for cardinalities doesn't fully align with the described SQL schema. For instance, MESSAGE ||--o| FEEDBACK implies a 'one-or-more-to-one' relationship, whereas the schema supports a 'one-to-many' relationship (one message can have multiple feedbacks).
To improve accuracy, I suggest updating the relationship markers to correctly represent the one-to-many (or one-to-zero-or-more) nature of the connections between entities.
| CHAT ||--o{ MESSAGE : contains | |
| CHAT ||--o{ FEEDBACK : receives | |
| MESSAGE ||--o| FEEDBACK : "rated by" | |
| KB_DOCUMENT ||--o{ KB_METADATA : has | |
| CHAT |o--o{ MESSAGE : contains | |
| CHAT |o--o{ FEEDBACK : receives | |
| MESSAGE |o--o{ FEEDBACK : "rated by" | |
| KB_DOCUMENT |o--o{ KB_METADATA : has |