Skip to content

docs: make English the default README, drop the version-freeze notes - #2

Merged
ludejun merged 1 commit into
masterfrom
docs/english-readme-default
Sep 23, 2026
Merged

ludejun merged 1 commit into
masterfrom
docs/english-readme-default

Conversation

@ludejun

@ludejun ludejun commented Sep 23, 2026

Copy link
Copy Markdown
Owner

Two things you asked for.

English is now the default README

README.md is the English version, README_CN.md the Chinese one. The language switcher at the top of each points at the other, and the mentions in CONTRIBUTING.md and CHANGELOG.md follow.

Every repo now has the same convention: README.md (English) + README_CN.md (Chinese).

The "will not be upgraded" callouts are gone

Removed the > [!NOTE] / > [!IMPORTANT] block near the top saying the stack stays where it is, along with the ### Not changed, deliberately changelog section where there was one.

Genuine build constraints are kept where they are actually needed — e.g. Deep-Viz-Website still documents under Requirements that roadhog 0.6 needs npm install --legacy-peer-deps and cannot run under pnpm, because that one is an instruction, not a disclaimer.

No code or configuration changes.

🤖 Generated with Claude Code

README.md is now the English version and README_CN.md the Chinese one, with the
language switcher in each pointing at the other. Cross-references in
CONTRIBUTING.md and CHANGELOG.md follow.

Also removes the callout about the stack not being upgraded, and the
"Not changed, deliberately" changelog section where there was one.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@ludejun
ludejun merged commit 0f976c2 into master Sep 23, 2026
2 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.

2 participants