docs: standardize Chinese documentation and fix broken links#862
docs: standardize Chinese documentation and fix broken links#862JasonYeYuhe wants to merge 1 commit intovolcengine:mainfrom
Conversation
|
|
|
Failed to generate code suggestions for PR |
There was a problem hiding this comment.
Pull request overview
This PR standardizes the Chinese top-level README naming to README.zh.md (for GitHub language conventions) and updates README cross-links, while also fixing a broken “Last Commit” badge link in the legacy Chinese README.
Changes:
- Add
README.zh.mdas the standardized Chinese README entrypoint. - Update language switcher links in
README.mdandREADME_JA.mdto point toREADME.zh.md. - Fix the broken
last-commit-shield-linkURL inREADME_CN.md.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Updates the Chinese language switcher link to README.zh.md. |
| README_JA.md | Updates the Chinese language switcher link to README.zh.md. |
| README_CN.md | Fixes the broken “Last Commit” badge link target URL. |
| README.zh.md | Introduces the standardized Chinese README and updates/contains documentation links. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| 👉 **[查看:使用 VikingBot 部署服务器](bot/README.zh.md)** | ||
|
|
||
| -- |
There was a problem hiding this comment.
The standalone -- line looks like an accidental typo (likely intended to be a Markdown horizontal rule ---). As-is it renders as plain text and breaks the section formatting.
| -- | |
| --- |
| 👉 **[查看:OpenClaw 上下文插件](examples/openclaw-plugin/README.zh.md)** | ||
|
|
||
| 👉 **[查看:OpenCode 记忆插件示例](examples/opencode-memory-plugin/README.zh.md)** |
There was a problem hiding this comment.
This link targets examples/openclaw-plugin/README.zh.md, but that file does not exist in the repo (only README_CN.md / README.md are present). This will render as a broken link; either add the README.zh.md file in that directory or update the link to an existing localized README.
| 👉 **[查看:OpenClaw 上下文插件](examples/openclaw-plugin/README.zh.md)** | |
| 👉 **[查看:OpenCode 记忆插件示例](examples/opencode-memory-plugin/README.zh.md)** | |
| 👉 **[查看:OpenClaw 上下文插件](examples/openclaw-plugin/README_CN.md)** | |
| 👉 **[查看:OpenCode 记忆插件示例](examples/opencode-memory-plugin/README_CN.md)** |
|
|
||
| 👉 **[查看:OpenClaw 上下文插件](examples/openclaw-plugin/README.zh.md)** | ||
|
|
||
| 👉 **[查看:OpenCode 记忆插件示例](examples/opencode-memory-plugin/README.zh.md)** |
There was a problem hiding this comment.
This link targets examples/opencode-memory-plugin/README.zh.md, but that file does not exist (the directory currently has README_CN.md / README.md). Please update the link to an existing file or add the missing README.zh.md to avoid a broken reference.
| 👉 **[查看:OpenCode 记忆插件示例](examples/opencode-memory-plugin/README.zh.md)** | |
| 👉 **[查看:OpenCode 记忆插件示例](examples/opencode-memory-plugin/README_CN.md)** |
|
|
||
| OpenViking 有一个类似 nanobot 的机器人用于交互工作,现已可用。 | ||
|
|
||
| 👉 **[查看:使用 VikingBot 部署服务器](bot/README.zh.md)** |
There was a problem hiding this comment.
This link points to bot/README.zh.md, but the bot/ directory currently contains README_CN.md / README.md and no README.zh.md. This will be a broken link unless the file is added or the link is updated to the correct target.
| 👉 **[查看:使用 VikingBot 部署服务器](bot/README.zh.md)** | |
| 👉 **[查看:使用 VikingBot 部署服务器](bot/README_CN.md)** |
docs: standardizing Chinese documentation to README.zh.md
Overview
This PR aims to standardize the Chinese documentation naming convention and fix minor broken links in the README files.
Changes
README.zh.md: Renamed/Migrated fromREADME_CN.md(while keeping both for compatibility if needed, but updated all internal references to use the standardized.zh.mdextension). This follows GitHub's common practice for automatic language detection.last-commit-shield-link(changedcommcommitstocommits) which was causing the "Last Commit" badge link to be broken in the Chinese version.README.md,README.zh.md, andREADME_JA.mdto point to the newREADME.zh.md.Why this matters
.zh.mdextension aligns with community standards and improves discoverability for developers using localized GitHub settings.Translated and contributed by @JasonYeYuhe