Skip to content

docs: make the English README the repository default - #10

Merged
falltwo merged 1 commit into
mainfrom
docs/english-readme-default
Jul 20, 2026
Merged

docs: make the English README the repository default#10
falltwo merged 1 commit into
mainfrom
docs/english-readme-default

Conversation

@falltwo

@falltwo falltwo commented Jul 20, 2026

Copy link
Copy Markdown
Owner

Summary

The repository already had a bilingual README pair, but GitHub always renders README.md on the landing page, so external readers saw the Chinese version first. This swaps which file holds which language.

Changes

File Before After
README.md Traditional Chinese English
README.zh.md did not exist Traditional Chinese
README.en.md English removed (content moved to README.md)

Also updated:

  • The language switcher line in both READMEs, now [English](README.md) | [繁體中文](README.zh.md).
  • The English README link in docs/releases/v1.0.md, which pointed at the old README.en.md path.

Not changed

No prose was rewritten in either language. Both files keep their existing content, badges, and language-specific diagrams (*_en.drawio.png and *_zh.drawio.png). File moves use git mv so history follows.

Verification

  • Both READMEs render their expected language.
  • No remaining references to README.en.md anywhere in the tree.
  • All 16 relative links across both files resolve to existing paths.

🤖 Generated with Claude Code

The repository already carried a bilingual pair, but GitHub always renders
README.md on the landing page, so external readers saw the Chinese version
first. This swaps which file holds which language.

- README.md now holds the English content (previously README.en.md).
- README.zh.md now holds the Traditional Chinese content.
- Update the language switcher in both files to point at the new paths.
- Update the English README link in the v1.0 release notes.

Content is unchanged in both languages; only the filenames and the
cross-links between them move.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@falltwo
falltwo merged commit b2df70b into main Jul 20, 2026
1 check passed
@falltwo
falltwo deleted the docs/english-readme-default branch July 20, 2026 23:54
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