Skip to content

docs: add English documentation as default language (EN/中文 switchable)#126

Merged
Sunrisepeak merged 1 commit into
mainfrom
docs/en-support
Jun 5, 2026
Merged

docs: add English documentation as default language (EN/中文 switchable)#126
Sunrisepeak merged 1 commit into
mainfrom
docs/en-support

Conversation

@Sunrisepeak
Copy link
Copy Markdown
Member

Summary

Adds full English support for the README and user docs, with mutual language-switch links, per the i18n request.

  • English is now the default: README.md and docs/*.md are English translations; GitHub visitors see English first.
  • Chinese preserved verbatim: moved to README.zh-CN.md and docs/zh/ (only links adjusted for the new layout).
  • Language switcher: English | 简体中文 links at the top of both READMEs and both docs indices.
  • Added the missing 06-workspace entry to the docs index (both languages).

Link integrity

  • All existing references to docs/*.md from src/ error messages, .agents/skills/, and CHANGELOG.md still resolve — English content now lives at the original paths, so nothing outside this PR needed changes.
  • Parent-relative links in docs/zh/ (../examples, README anchor) fixed for the one-level-deeper location.
  • Verified: script-checked every relative link in all 20 markdown files (0 broken), zero leftover Chinese in English files, and EN/ZH structural parity (identical heading and code-fence counts per file).

Review notes

Translations aim for idiomatic technical English (Cargo-docs tone) rather than literal word-for-word; all commands, code, TOML, and output blocks are verbatim from the Chinese originals (code comments translated).

🤖 Generated with Claude Code

… README.zh-CN

- README.md and docs/ are now English (international default)
- Chinese moved to README.zh-CN.md and docs/zh/, content unchanged
- Language switch links (English | 简体中文) at the top of both READMEs
  and both docs indices
- Fixed parent-relative links in docs/zh (one level deeper) and the
  README install anchor in docs/00
- Added missing 06-workspace entry to both docs indices
- Existing docs/*.md links from src/, skills, and CHANGELOG keep
  resolving (English now lives at the original paths)
@Sunrisepeak Sunrisepeak merged commit 9215dee into main Jun 5, 2026
3 checks passed
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.

1 participant