Skip to content

docs: standardize Chinese documentation and fix broken links#862

Open
JasonYeYuhe wants to merge 1 commit intovolcengine:mainfrom
JasonYeYuhe:docs-i18n-standardize
Open

docs: standardize Chinese documentation and fix broken links#862
JasonYeYuhe wants to merge 1 commit intovolcengine:mainfrom
JasonYeYuhe:docs-i18n-standardize

Conversation

@JasonYeYuhe
Copy link

@JasonYeYuhe JasonYeYuhe commented Mar 22, 2026

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

  • Added README.zh.md: Renamed/Migrated from README_CN.md (while keeping both for compatibility if needed, but updated all internal references to use the standardized .zh.md extension). This follows GitHub's common practice for automatic language detection.
  • Fixed broken links: Corrected a typo in the last-commit-shield-link (changed commcommits to commits) which was causing the "Last Commit" badge link to be broken in the Chinese version.
  • Updated language switchers: Synchronized the language selection links across README.md, README.zh.md, and README_JA.md to point to the new README.zh.md.

Why this matters

  1. Consistency: Using the .zh.md extension aligns with community standards and improves discoverability for developers using localized GitHub settings.
  2. Maintenance: Fixing the broken commit badge link ensures a professional and high-quality presentation for users interested in project activity.
  3. Navigability: Unified language links across all README variants provide a seamless switching experience.

Translated and contributed by @JasonYeYuhe

Copilot AI review requested due to automatic review settings March 22, 2026 06:28
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions
Copy link

Failed to generate code suggestions for PR

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.md as the standardized Chinese README entrypoint.
  • Update language switcher links in README.md and README_JA.md to point to README.zh.md.
  • Fix the broken last-commit-shield-link URL in README_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)**

--
Copy link

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
--
---

Copilot uses AI. Check for mistakes.
Comment on lines +558 to +560
👉 **[查看:OpenClaw 上下文插件](examples/openclaw-plugin/README.zh.md)**

👉 **[查看:OpenCode 记忆插件示例](examples/opencode-memory-plugin/README.zh.md)**
Copy link

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
👉 **[查看: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)**

Copilot uses AI. Check for mistakes.

👉 **[查看:OpenClaw 上下文插件](examples/openclaw-plugin/README.zh.md)**

👉 **[查看:OpenCode 记忆插件示例](examples/opencode-memory-plugin/README.zh.md)**
Copy link

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
👉 **[查看:OpenCode 记忆插件示例](examples/opencode-memory-plugin/README.zh.md)**
👉 **[查看:OpenCode 记忆插件示例](examples/opencode-memory-plugin/README_CN.md)**

Copilot uses AI. Check for mistakes.

OpenViking 有一个类似 nanobot 的机器人用于交互工作,现已可用。

👉 **[查看:使用 VikingBot 部署服务器](bot/README.zh.md)**
Copy link

Copilot AI Mar 22, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
👉 **[查看:使用 VikingBot 部署服务器](bot/README.zh.md)**
👉 **[查看:使用 VikingBot 部署服务器](bot/README_CN.md)**

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

3 participants