-
Notifications
You must be signed in to change notification settings - Fork 47
Support Chinese Docs #277
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support Chinese Docs #277
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @hiyuchang, 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 enhancing the project's documentation by adding comprehensive support for the Chinese language. It involves creating a dedicated set of documentation files in Chinese, implementing a user-friendly language switcher for navigation, and updating the underlying build system to correctly generate and manage both English and Chinese versions of the documentation. These changes are crucial for expanding the project's reach and usability for a global audience.
Highlights
- Chinese Documentation Added: Introduced a complete set of Chinese documentation, including tutorials, API references, and a main overview, making the project accessible to a Chinese-speaking audience.
- Language Switcher Implementation: Added a functional language toggle button to the documentation header, allowing users to seamlessly switch between English and Chinese versions of the content.
- Documentation Build Process Refactored: The
build_doc.shscript has been significantly updated to support building both English and Chinese documentation into separate language-specific output directories, improving the multi-language build workflow. - Sphinx Configuration and Directory Restructuring: Modified existing Sphinx configuration files and added new ones specifically for Chinese documentation, alongside a restructuring of documentation directories to accommodate the multi-language setup.
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.
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 introduces support for Chinese documentation by adding a parallel source tree, updating the build script, and implementing a language switcher. The overall approach is sound, particularly the refactoring of the build script to handle multiple languages cleanly. However, there are a few areas for improvement. The new build script contains a minor syntax error. The JavaScript for the language switcher uses dated syntax. There is significant code duplication between the English and Chinese Sphinx configuration files, which could be refactored for better maintainability. Most critically, the new Chinese documentation uses hardcoded absolute URLs that point to the English version of the site, which would create a confusing experience for users.
Description
As the title says.
Checklist
Please check the following items before code is ready to be reviewed.