Skip to content

[Doc]Add Chinese translation for documentation #1870

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

Merged
merged 3 commits into from
Jul 21, 2025

Conversation

aidoczh
Copy link
Contributor

@aidoczh aidoczh commented Jul 18, 2025

What this PR does / why we need it?

This PR adds a complete Chinese translation for the documentation using PO files and the gettext toolchain. The goal is to make the documentation more accessible to Chinese-speaking users and help the community grow.

Does this PR introduce any user-facing change?

Yes. This PR introduces Chinese documentation, which users can access alongside the original English documentation. No changes to the core code or APIs.

How was this patch tested?

The translated documentation was built locally using the standard documentation build process (make html or sphinx-build). I checked the generated HTML pages to ensure the Chinese content displays correctly and matches the original structure. No code changes were made, so no additional code tests are required.

vLLM version: v0.9.2
vLLM main: vllm-project/vllm@5780121


Please review the translation and let me know if any improvements are needed. I am happy to update the translation based on feedback.

Signed-off-by: aidoczh <aidoczh@163.com>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 18, 2025
@wangxiyuan
Copy link
Collaborator

wangxiyuan commented Jul 18, 2025

can we add a switch button at index page? https://vllm-ascend.readthedocs.io/en/latest/

Copy link
Collaborator

@Yikun Yikun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

After this PR merged, we need to

  1. keep vllm-ascend version
  2. add a new vllm-ascend-cn version in readdoc.
  3. vllm-ascend add a translations
image

The we can get something like:
https://vllm-ascend-en-yikun.readthedocs.io/zh-cn/latest/

Signed-off-by: Yikun Jiang <yikunkero@gmail.com>
Copy link
Collaborator

@Yikun Yikun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW, some typos need to be addressed, I will take a deep look soon

Signed-off-by: Yikun Jiang <yikunkero@gmail.com>
@Yikun Yikun force-pushed the add-chinese-translation branch from 6cc3533 to 4978ef3 Compare July 21, 2025 00:56
@Yikun
Copy link
Collaborator

Yikun commented Jul 21, 2025

Thanks for contributions, I addressed some nits:

  1. fix some typo
  2. Add make intl in docs/Makefile
  3. remove language = 'en' in conf.py

@aidoczh Would you mind taking a look again?

Preview: https://vllm-ascend-en-yikun.readthedocs.io/en/latest/

@wjjc1017
Copy link

Thanks for contributions, I addressed some nits:

  1. fix some typo
  2. Add make intl in docs/Makefile
  3. remove language = 'en' in conf.py

@aidoczh Would you mind taking a look again?

Preview: https://vllm-ascend-en-yikun.readthedocs.io/en/latest/

Points 2 and 3 can be fixed quickly, but point 1 might take a bit more time. I will review these issues and see how to address them systematically.

@Yikun
Copy link
Collaborator

Yikun commented Jul 21, 2025

@wjjc1017 I already had initial fix for them in this PR. Please feel free to submit new PR in future.

@wangxiyuan
Copy link
Collaborator

After this PR merged, once the English doc is changed, what should we do for Chinese version? Developer should update the Chinese at the same time, or is there any sync way?

@aidoczh
Copy link
Contributor Author

aidoczh commented Jul 21, 2025

After this PR merged, once the English doc is changed, what should we do for Chinese version? Developer should update the Chinese at the same time, or is there any sync way?

I will monitor new releases of the project. When a new version is released, I will automatically trigger a translation workflow to update the documentation PO files and submit a PR. I will continue to develop and maintain this automated translation workflow in the future.

@wangxiyuan wangxiyuan merged commit c32eea9 into vllm-project:main Jul 21, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants