[Docs] Fix the illustration of plugin workflow#288
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @haochengxia, 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 focuses on improving the documentation for the plugin workflow. It rectifies an incorrect flow in an existing Mermaid diagram and introduces a new section to clarify challenges and provide guidance for users attempting to re-implement cache eviction algorithms using the plugin system, particularly concerning how state updates should be handled when the find function is not directly exposed to plugins.
Highlights
- Documentation Correction: Corrected an erroneous flow in the Mermaid diagram within
doc/quickstart_plugin.mdto accurately represent thecache_eviction_hookreturning to the "Cache full?" check. - Plugin Implementation Guidance: Added a new section detailing potential implementation issues when re-implementing eviction algorithms using the plugin system, emphasizing the need to handle state-update logic within hook functions due to the
findfunction not being exposed. This includes a new Mermaid diagram for 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request improves the plugin documentation by correcting a workflow diagram and adding a helpful section on implementation challenges when using the plugin system. The changes are clear and valuable for developers using plugins. I have one suggestion to improve the clarity of the new diagram to make it more consistent with the accompanying text.
6a7f934 to
4eee4f5
Compare
81b209d to
85dc188
Compare
Uh oh!
There was an error while loading. Please reload this page.