Skip to content

Conversation

@XuZhang99
Copy link
Collaborator

No description provided.

@XuZhang99 XuZhang99 marked this pull request as draft January 5, 2026 09:41
Copy link

@gemini-code-assist gemini-code-assist bot left a 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.

@XuZhang99 XuZhang99 force-pushed the docs/refine_readme branch 2 times, most recently from f7247ce to 122ecba Compare January 5, 2026 13:20
@XuZhang99 XuZhang99 marked this pull request as ready for review January 5, 2026 13:21
@XuZhang99 XuZhang99 force-pushed the docs/refine_readme branch 2 times, most recently from d402716 to fdce58e Compare January 5, 2026 13:37
@XuZhang99
Copy link
Collaborator Author

/gemini review

Copy link

@gemini-code-assist gemini-code-assist bot left a 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.

@XuZhang99 XuZhang99 force-pushed the docs/refine_readme branch 3 times, most recently from b353b58 to 28e4a40 Compare January 6, 2026 06:13
Clement-Wang26
Clement-Wang26 previously approved these changes Jan 6, 2026
@RobbieLeung RobbieLeung merged commit bc59bf2 into jd-opensource:main Jan 9, 2026
9 checks passed
DongheJin pushed a commit to DongheJin/xllm that referenced this pull request Jan 14, 2026
weizhehuang0827 pushed a commit to weizhehuang0827/xllm that referenced this pull request Jan 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants