update readme #390
update readme #390
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 @Harahan, 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 user experience by cleaning up and standardizing the README files across all supported languages. The changes streamline information presentation, particularly for Docker usage and documentation access, making it easier for users to find relevant details.
Highlights
- README Restructuring: The README files (
README.md,README_ja.md,README_zh.md) have been reorganized to improve clarity and readability. Redundant documentation and Docker-related links were removed from the main introductory sections. - Consolidated Docker Instructions: Docker pull commands for both Docker Hub and Aliyun Docker have been consolidated into a single, clearer code block in all README versions. Comments have been added to specify the source of each command, and the code block type has been explicitly set to
shell. - Dedicated Documentation Section: A new 'Docs' section has been introduced towards the end of each README file, providing a centralized location for links to the English and Chinese documentation. This replaces the previously scattered links.
- Language Link Correction: The language selection links at the top of
README_ja.mdandREADME_zh.mdhave been updated to correctly point toREADME.mdfor the English version, ensuring proper navigation between language variants.
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
The PR updates the README files (English, Japanese, and Chinese) to improve structure and conciseness. Key changes include relocating the language switcher, consolidating Docker download instructions and commands, and adding a dedicated "Docs" section. These changes generally enhance readability. A minor point regarding the clarity of Docker tag usage in comments has been noted with suggestions for improvement across all three README files.
| aliyun docker | ||
|
|
||
| ``` | ||
| # aliyun docker: registry.cn-hangzhou.aliyuncs.com/yongyang/llmcompression:[tag] |
There was a problem hiding this comment.
The comment for Aliyun Docker uses [tag] as a placeholder, while the command on the next line (line 27) specifies pure-latest. This might cause slight confusion for users, as they might wonder if they need to replace pure-latest or if pure-latest is the intended specific tag for the example.
To improve clarity and consistency, consider making the comment directly reflect the tag used in the example command if pure-latest is the intended default or example tag.
| # aliyun docker: registry.cn-hangzhou.aliyuncs.com/yongyang/llmcompression:[tag] | |
| # aliyun docker: registry.cn-hangzhou.aliyuncs.com/yongyang/llmcompression:pure-latest |
| 阿里云Docker | ||
|
|
||
| ``` | ||
| # 阿里云Docker: registry.cn-hangzhou.aliyuncs.com/yongyang/llmcompression:[tag] |
There was a problem hiding this comment.
The comment for Aliyun Docker (阿里云Docker) uses [tag] as a placeholder, while the command on the next line (line 27) specifies pure-latest. This mirrors the situation in the English README and could lead to similar minor confusion for users regarding the tag.
For better clarity, it's recommended to align the comment with the example command if pure-latest is the intended tag for this specific instruction.
| # 阿里云Docker: registry.cn-hangzhou.aliyuncs.com/yongyang/llmcompression:[tag] | |
| # 阿里云Docker: registry.cn-hangzhou.aliyuncs.com/yongyang/llmcompression:pure-latest |
| 阿里云docker | ||
|
|
||
| ``` | ||
| # 阿里云docker: registry.cn-hangzhou.aliyuncs.com/yongyang/llmcompression:[tag] |
There was a problem hiding this comment.
The comment for Aliyun Docker (阿里云docker) uses [tag] as a placeholder, whereas the command on the next line (line 27) uses the specific tag pure-latest. This inconsistency, also present in the other README versions, might cause minor confusion.
To enhance clarity, it would be beneficial to make the comment consistent with the provided example command, assuming pure-latest is the intended tag for this example.
| # 阿里云docker: registry.cn-hangzhou.aliyuncs.com/yongyang/llmcompression:[tag] | |
| # 阿里云docker: registry.cn-hangzhou.aliyuncs.com/yongyang/llmcompression:pure-latest |
No description provided.