Skip to content

Add architecture images and update docs#2

Merged
mohit-nagaraj merged 1 commit intomainfrom
dev
Feb 16, 2026
Merged

Add architecture images and update docs#2
mohit-nagaraj merged 1 commit intomainfrom
dev

Conversation

@mohit-nagaraj
Copy link
Member

Add multiple PNG assets for architecture and workflow diagrams and replace verbose inline ASCII diagrams with embedded images across documentation. Updated docs: src/content/docs/architecture/cli.md, core-backend.md, data-flow.md, ecosystem-overview.md, ui-frontend.md, and guides/workflow-lifecycle.md to reference the new images (under src/assets/images/). Also simplified some flows (auth, container build, docker-compose import, Zustand stores) into concise lists/tables. Added .mcp.json to .gitignore.

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

Checklist

This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.

  • Design: A design document was considered and is present (link) or not required
  • PR: The PR description is expressive enough and will help future contributors
  • Code: Write code that humans can understand and Keep it simple
  • Refactor: You have left the code cleaner than you found it (Boy Scout Rule)
  • Upgrade: Impact of this change on upgrade flows was considered and addressed if required
  • Testing: New code requires new unit tests. New features and bug fixes require at least one e2e test
  • Documentation: A user-guide update was considered and is present (link) or not required. You want a user-guide update if it's a user facing feature / API change.
  • Community: Announcement to the community was considered

Release note:


@gemini-code-assist
Copy link

Summary of Changes

Hello @mohit-nagaraj, 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 significantly improves the clarity and maintainability of the project's documentation by replacing outdated and verbose ASCII diagrams with modern, embedded PNG images. It also refines several architectural and workflow descriptions, making complex processes easier to understand for developers and users, ultimately enhancing the overall documentation quality.

Highlights

  • Documentation Enhancement: Replaced verbose inline ASCII diagrams with embedded PNG images across several architecture and guide documents to improve visual clarity.
  • New Visual Assets: Added multiple PNG assets for architecture and workflow diagrams to the src/assets/images/ directory.
  • Content Simplification: Streamlined descriptions for authentication, container build, Docker Compose import, and Zustand store flows into more concise lists or tables.
  • Git Ignore Update: Added .mcp.json to the .gitignore file to prevent tracking of specific project configuration files.
Changelog
  • .gitignore
    • Added .mcp.json to the ignore list.
  • src/content/docs/architecture/cli.md
    • Replaced ASCII diagrams with image references for production, full development, frontend-only, and backend-only modes.
  • src/content/docs/architecture/core-backend.md
    • Replaced ASCII diagram with an image reference for the layered backend architecture.
  • src/content/docs/architecture/data-flow.md
    • Replaced ASCII diagrams with image references for workflow creation, deployment, node-to-manifest transformation, container build, and real-time monitoring flows.
    • Simplified the descriptions for built-in email/password and OAuth2/OIDC authentication flows into concise lists.
    • Replaced the Docker Compose import flow ASCII diagram with an image reference.
  • src/content/docs/architecture/ecosystem-overview.md
    • Replaced ASCII diagram with an image reference for the overall system architecture.
  • src/content/docs/architecture/ui-frontend.md
    • Replaced the ASCII table describing Zustand stores with a more readable Markdown table.
  • src/content/docs/guides/workflow-lifecycle.md
    • Replaced ASCII diagram with an image reference for workflow states.
Activity
  • No human activity has been recorded for this pull request yet.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request is a great step forward for the project's documentation. The replacement of ASCII diagrams with proper images and markdown tables/lists significantly improves readability and maintainability. The addition to the .gitignore file is also appropriate. The changes are well-executed and I have no further suggestions for improvement.

Add multiple PNG assets for architecture and workflow diagrams and replace verbose inline ASCII diagrams with embedded images across documentation. Updated docs: src/content/docs/architecture/cli.md, core-backend.md, data-flow.md, ecosystem-overview.md, ui-frontend.md, and guides/workflow-lifecycle.md to reference the new images (under src/assets/images/). Also simplified some flows (auth, container build, docker-compose import, Zustand stores) into concise lists/tables. Added .mcp.json to .gitignore.

Signed-off-by: Mohit Nagaraj <mohitnagaraj20@gmail.com>
@mohit-nagaraj mohit-nagaraj merged commit 118775d into main Feb 16, 2026
2 checks passed
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