Added diagram to README.md

[ctyano]

Type of changes

Choose one of the below, or leave them empty:

• New feature proposal
• Bug fix
• Minor improvements
• Refactoring (no functional changes)
• Non-code changes (updating documentation, workflows, etc.)

[gemini-code-assist]

Summary of Changes

Hello @ctyano, I'm Gemini Code Assist¹! 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 project's documentation by introducing a visual representation of its workflow. A PlantUML diagram has been embedded in the README.md to provide a clear, high-level understanding of how the system operates, alongside a minor restructuring of the documentation sections for better readability.

Highlights

• Documentation Enhancement: A PlantUML diagram has been integrated into the README.md to visually explain the project's operational flow, replacing the previous "How to build" section.
• README Structure Refinement: The "How to build" instructions have been relocated to a new, dedicated section at the end of the README.md for improved organization and clarity.

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. ↩

[gemini-code-assist]

Code Review

This pull request improves the README.md by adding a workflow diagram and reorganizing sections. The change is a good improvement to the documentation. I have one suggestion regarding the new diagram to improve accessibility and long-term maintainability by adding alt text and self-hosting the diagram, which aligns with the repository's style guide principles of Readability and Maintainability.

[gemini-code-assist]

For accessibility, please add descriptive alt text to the image. Also, to improve long-term maintainability and remove the dependency on the external plantuml.biz service, consider committing the diagram's source and the generated SVG to the repository and linking to the local file.

Suggested change

[](https://editor.plantuml.com/uml/ZLLDRzim3BthLn3kfSNW5RtkK7JjWA5OXns6Oi3QOP1bDjQgIAu-cYP3_lj8oKxjPbyvE8hrtYFvH2fd8KeVqz88WtSHeWEl5rs4LdjKKJihHDJH85HlOuTs0zS1uKBImrdua1hq5YE6IWYfelDJcAz01aYq4FHGpAc-O0Fdtgt6tQQidm43_UBgCkyhe_VsM1ekq4T6tTh3bVFtWS5EfjX1dngZ5JFHngDT3ee91v-yj0iKGXcNMgYU2o1y2f6p-Ya0bFJjBfv78oEsG6aah-CQb5lspf9wA6Z-58Row_vUbymz75onbUyzejtX0AnhSKJMmTt5BYmB8qnG03S5ygs8yNAwEH3pxh3URM_5_Fk6QmzwOT7NlNTFwttJ-E6ytaW-SghKFw8_okAPC0gr-BJFrIrPmRuGz95-34J2phmfRkPAPJ6s-7Dk4kxPKn1rAbwckJ7SHDUNEKZIUrM_aDWiGrtgoLARkTJNZv-p3g7-9TGsMQ1jPWgjZBAPTkUxyse6e20a_hsaS6j7_1YrRIROxM-FS2ksWeV0GrtNf-F8m1keN8-sccnHp_DhVCBS_t0CnYbfEXVYS5PbAgQStMnCY3JDOvGwzIz0pv9IAGm13hiO-wCfXndwhzYTuEjJRXJ6UYntpbXWDTCRG7yKv78PHvOoJlQQsiuOM6cgEbURmosZ6JY1vZh4QIfCpztE0ln6tsb5amyyEjhg1J4U4f56WLVmOyKA8irYUvJjyOfk2XoJLCv6xmpqZcwczK0d8XC68hKLKNVTD11pzeVBTNWm7ATabqywNmZ_cIZRK_1C7MuBvkxZ-tiLJauuriYuwNHB0_wDpw0HuWnjo_yMlm00)

[](https://editor.plantuml.com/uml/ZLLDRzim3BthLn3kfSNW5RtkK7JjWA5OXns6Oi3QOP1bDjQgIAu-cYP3_lj8oKxjPbyvE8hrtYFvH2fd8KeVqz88WtSHeWEl5rs4LdjKKJihHDJH85HlOuTs0zS1uKBImrdua1hq5YE6IWYfelDJcAz01aYq4FHGpAc-O0Fdtgt6tQQidm43_UBgCkyhe_VsM1ekq4T6tTh3bVFtWS5EfjX1dngZ5JFHngDT3ee91v-yj0iKGXcNMgYU2o1y2f6p-Ya0bFJjBfv78oEsG6aah-CQb5lspf9wA6Z-58Row_vUbymz75onbUyzejtX0AnhSKJMmTt5BYmB8qnG03S5ygs8yNAwEH3pxh3URM_5_Fk6QmzwOT7NlNTFwttJ-E6ytaW-SghKFw8_okAPC0gr-BJFrIrPmRuGz95-34J2phmfRkPAPJ6s-7Dk4kxPKn1rAbwckJ7SHDUNEKZIUrM_aDWiGrtgoLARkTJNZv-p3g7-9TGsMQ1jPWgjZBAPTkUxyse6e20a_hsaS6j7_1YrRIROxM-FS2ksWeV0GrtNf-F8m1keN8-sccnHp_DhVCBS_t0CnYbfEXVYS5PbAgQStMnCY3JDOvGwzIz0pv9IAGm13hiO-wCfXndwhzYTuEjJRXJ6UYntpbXWDTCRG7yKv78PHvOoJlQQsiuOM6cgEbURmosZ6JY1vZh4QIfCpztE0ln6tsb5amyyEjhg1J4U4f56WLVmOyKA8irYUvJjyOfk2XoJLCv6xmpqZcwczK0d8XC68hKLKNVTD11pzeVBTNWm7ATabqywNmZ_cIZRK_1C7MuBvkxZ-tiLJauuriYuwNHB0_wDpw0HuWnjo_yMlm00)

References

1. Per the style guide's principle of Readability (line 12), adding alt text to images makes documentation more accessible. ^(link)
2. Per the style guide's principle of Maintainability (line 13), self-hosting documentation assets avoids external dependencies and makes the project easier to maintain. ^(link)