feat: add Chinese localization for README files#80
feat: add Chinese localization for README files#80xinxingi wants to merge 1 commit intoapache:masterfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds Simplified Chinese documentation support by introducing a Chinese README and exposing a language switcher in the main README, aligning with Issue #79’s request for bilingual docs entry points.
Changes:
- Added a new Simplified Chinese README at
docs/zh-CN/README.zh-CN.md. - Added an English/简体中文 language switcher link near the top of
README.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/zh-CN/README.zh-CN.md | Adds a full Simplified Chinese README translation/content for the project docs. |
| README.md | Adds a top-of-file language navigation link to the Chinese README. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```python | ||
| auth_info = { | ||
| "type": "token", | ||
| "token": "your_jwt_token", |
There was a problem hiding this comment.
In the Token auth example, type is "token" but the placeholder value is "your_jwt_token", which is confusing and suggests the wrong credential type. Update the placeholder to reflect a token value (or change the example to JWT auth if that’s what’s intended).
| "token": "your_jwt_token", | |
| "token": "your_access_token", |
| ├── logs/ # 日志目录 | ||
| ├── tokens.json # Token 配置文件 | ||
| ├── README.md # 英文文档 | ||
| ├── README.zh-CN.md # 中文文档 |
There was a problem hiding this comment.
The directory tree example lists a top-level README.zh-CN.md, but this PR adds the Chinese README under docs/zh-CN/README.zh-CN.md and there is no README.zh-CN.md at repo root. Please update this tree to match the actual file locations to avoid confusing readers.
| ├── README.zh-CN.md # 中文文档 | |
| ├── docs/ # 文档目录 | |
| │ └── zh-CN/ | |
| │ └── README.zh-CN.md # 中文文档 |
|
|
||
| ## License | ||
|
|
||
| 本项目基于 Apache 2.0 License 发布，详见 `LICENSE` 文件。 |
There was a problem hiding this comment.
This section refers to a LICENSE file, but the repository contains LICENSE.txt. Please reference the correct filename so users can find the license text easily.
| 本项目基于 Apache 2.0 License 发布，详见 `LICENSE` 文件。 | |
| 本项目基于 Apache 2.0 License 发布，详见 `LICENSE.txt` 文件。 |
| pip install doris-mcp-server | ||
|
|
||
| # 安装指定版本 | ||
| pip install doris-mcp-server==0.6.0 |
There was a problem hiding this comment.
The pinned install example uses doris-mcp-server==0.6.0, but the project version in pyproject.toml is 0.6.1. This makes the Chinese README (and potentially its “v0.6.0” framing) immediately outdated/misleading; consider updating the version references to match the current release/version declared in the repo.
| pip install doris-mcp-server==0.6.0 | |
| pip install doris-mcp-server==0.6.1 |
#79