Devv #406
Devv #406
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @helloyongyang, 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 primarily focuses on enhancing the project's documentation ecosystem. It improves external visibility by integrating a DeepWiki badge into the READMEs and expands the capabilities of the documentation build process by adding new Sphinx extensions, suggesting an intent to support richer and more structured content.
Highlights
- Documentation Visibility: Added a new 'Ask DeepWiki' badge to the main
README.mdand its localized versions (README_ja.md,README_zh.md). This badge links to the project's DeepWiki page, aiming to improve discoverability and engagement with the project's knowledge base. - Documentation Build Enhancements: Updated the documentation build requirements by adding
sphinxcontrib-katexandsphinxcontrib.contentuitorequirements/docs.txt. These additions likely enable advanced features such as rendering mathematical equations (via KaTeX) and improving content organization or UI within the Sphinx-generated documentation.
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 is currently in preview and 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 to provide feedback.
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 adds a new 'Ask DeepWiki' badge to the README files and includes new Sphinx extensions for the documentation. My review identified a critical issue with an incorrect package name in requirements/docs.txt that will prevent the documentation from building. I've also pointed out that the new badge in the README files links back to the repository itself instead of the DeepWiki page, which should be corrected for it to be useful.
| @@ -5,3 +5,5 @@ myst-parser == 2.0.0 | |||
| sphinx-argparse | |||
| sphinxcontrib.redoc | |||
| sphinxcontrib.openapi | |||
| sphinxcontrib-katex | |||
| sphinxcontrib.contentui | |||
There was a problem hiding this comment.
The package name sphinxcontrib.contentui is incorrect and will cause the pip install command to fail. The correct package name on PyPI is sphinxcontrib-contentui (with a hyphen). While it is referenced as sphinxcontrib.contentui in conf.py (which is correct for Sphinx extensions), the package name for installation must be corrected here.
sphinxcontrib-contentui
| @@ -4,6 +4,7 @@ | |||
| <img src="./imgs/llmc.png" alt="llmc" width="75%" /> | |||
|
|
|||
| [](https://opensource.org/licenses/Apache-2.0) | |||
| [](https://github.com/ModelTC/llmc) | |||
There was a problem hiding this comment.
The link for the 'Ask DeepWiki' badge points back to the repository itself, which is not helpful for users. It should likely point to the project's page on DeepWiki. Based on DeepWiki's common URL structure, the link should probably be https://deepwiki.com/repo/ModelTC/llmc.
| [](https://github.com/ModelTC/llmc) | |
| [](https://deepwiki.com/repo/ModelTC/llmc) |
| @@ -4,6 +4,7 @@ | |||
| <img src="./imgs/llmc.png" alt="llmc" width="75%" /> | |||
|
|
|||
| [](https://opensource.org/licenses/Apache-2.0) | |||
| [](https://github.com/ModelTC/llmc) | |||
There was a problem hiding this comment.
The link for the 'Ask DeepWiki' badge points back to the repository itself, which is not helpful for users. It should likely point to the project's page on DeepWiki. Based on DeepWiki's common URL structure, the link should probably be https://deepwiki.com/repo/ModelTC/llmc.
| [](https://github.com/ModelTC/llmc) | |
| [](https://deepwiki.com/repo/ModelTC/llmc) |
| @@ -4,6 +4,7 @@ | |||
| <img src="./imgs/llmc.png" alt="llmc" width="75%" /> | |||
|
|
|||
| [](https://opensource.org/licenses/Apache-2.0) | |||
| [](https://github.com/ModelTC/llmc) | |||
There was a problem hiding this comment.
The link for the 'Ask DeepWiki' badge points back to the repository itself, which is not helpful for users. It should likely point to the project's page on DeepWiki. Based on DeepWiki's common URL structure, the link should probably be https://deepwiki.com/repo/ModelTC/llmc.
| [](https://github.com/ModelTC/llmc) | |
| [](https://deepwiki.com/repo/ModelTC/llmc) |
No description provided.