-
Notifications
You must be signed in to change notification settings - Fork 47
Fix links in readme #225
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
Fix links in readme #225
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 @yanxi-chen, 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 accuracy and consistency of documentation links across the repository. It updates various internal and external links within the README.md, README_zh.md, and docs/sphinx_doc/source/main.md files to ensure they point to the correct locations and use the appropriate file extensions, thereby enhancing the navigability and reliability of the project's documentation.
Highlights
- Documentation Link Corrections: Corrected file extensions for several internal documentation links from .html to .md in both English and Chinese README files, ensuring direct access to Markdown source files.
- Path Adjustments in Sphinx Docs: Updated relative paths in the main Sphinx documentation file (docs/sphinx_doc/source/main.md) to use root-relative paths for internal tutorials and an absolute GitHub URL for the benchmark tool, improving link robustness.
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 fixes several broken or incorrect links in the README.md, README_zh.md, and docs/sphinx_doc/source/main.md files. The changes correctly update file extensions from .html to .md and adjust paths to be correct relative to their location. The changes are good and improve the documentation. I've added a couple of suggestions for docs/sphinx_doc/source/main.md to use Sphinx's {ref} role for cross-referencing, which would improve consistency with other parts of the documentation.
Description
As the title says.
Checklist
Please check the following items before code is ready to be reviewed.