-
Notifications
You must be signed in to change notification settings - Fork 122
docs: refine readme to improve readability. #647
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
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.
Code Review
This pull request significantly improves the documentation by refactoring the main README files and organizing content into more specific documents. This makes the information easier to find and digest for users. The changes are well-structured and applied consistently across both English and Chinese versions. However, I've identified a high-severity security concern in the new quick_start.md files. The example docker run commands suggest mounting the entire host /home directory, which poses a security risk. My review includes suggestions to scope down the volume mounts to enhance security for users who might copy-paste these commands.
f7247ce to
122ecba
Compare
d402716 to
fdce58e
Compare
|
/gemini review |
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 significantly refactors the documentation by reorganizing content from the main README into more detailed pages under the docs/ directory. The changes improve the structure and readability of the documentation, making it easier for users to navigate. I've identified a couple of high-severity issues in the new quick_start.md files where the docker run command for NPU environments is inconsistent and likely incorrect, which could cause confusion for users. I've provided suggestions to fix these commands.
fdce58e to
ca5fa46
Compare
b353b58 to
28e4a40
Compare
28e4a40 to
e3dccb9
Compare
No description provided.