Skip to content

Conversation

@ChanukaUOJ
Copy link
Contributor

Summary

This PR includes the fixing for rendering issue of the architecture diagram in the architecture diagram in documentation. The issue was ( ) inside the labels parse an error if the label is not a string.

Key Changes

  • The mermaid digram in ai/architecture.md file updated.
  • Wrapped labels with " " to parse the label as string

Testing

Digram tested in the mermaid live editor
See the diagram

Closes: #414

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @ChanukaUOJ, 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 addresses a critical rendering problem within the architecture documentation's Mermaid diagram. The issue stemmed from Mermaid's inability to correctly parse labels that included parentheses unless explicitly treated as strings. By enclosing these problematic labels in double quotes, the change ensures the diagram displays as intended, improving the clarity and accuracy of the architectural overview.

Highlights

  • Mermaid Diagram Fix: Resolved a rendering issue in the architecture documentation's Mermaid diagram where labels containing parentheses were causing parsing errors.
  • Label String Parsing: Implemented a fix by wrapping affected Mermaid diagram labels with double quotes, ensuring they are correctly parsed as strings and preventing rendering failures.
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
Contributor

@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 correctly fixes a rendering issue in the Mermaid architecture diagram in ai/architecture.md. By wrapping labels containing parentheses in double quotes, the diagram now parses correctly. The change is accurate and resolves the issue as described.

@vibhatha
Copy link
Member

This is nice. Thanks @ChanukaUOJ

@vibhatha vibhatha merged commit 4223fc1 into LDFLK:main Dec 27, 2025
3 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.

[Document] Architecture diagram unable to render rich display

2 participants