docs: lead in Korean, and reorder the language switcher - #18
Merged
Conversation
README.md is now the Korean file and English moves to README.en.md, so the page GitHub shows first is Korean. The switcher is reordered to 한국어 / English / 中文 / 日本語 in all four files, each bolding its own language. Done with git mv so the history follows the content rather than reading as one file deleted and another added. Every cross-reference is repointed. The "see the English README" notes in the Korean, Chinese and Japanese files pointed at README.md, which is now the Korean one -- they would have silently become self-links, which is worse than a broken link because nothing reports it. pyproject's `readme` moves to README.en.md rather than following README.md. It is the package's long description on PyPI, and that audience is not the repository's: the repo leads in Korean by choice, the index should stay readable to anyone installing. Verified by building the sdist and reading the resulting PKG-INFO. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README.mdis now the Korean file and English moves toREADME.en.md, so thepage GitHub shows first is Korean. The switcher is reordered to
한국어 / English / 中文 / 日本語 in all four files, each bolding its own language.
Done with
git mv, so history follows the content rather than reading as one filedeleted and another added.
Cross-references
Every pointer is repointed. The "see the English README" notes in the Korean,
Chinese and Japanese files all pointed at
README.md— which is now the Koreanfile. Left alone they would have become silent self-links, which is worse than a
broken link because nothing reports it.
pyproject
readmemoves toREADME.en.mdrather than followingREADME.md. It becomes thepackage's long description on PyPI, and that audience is not the repository's: the
repo leads in Korean by choice, but the index should stay readable to anyone
installing the package. Verified by building the sdist and reading the resulting
PKG-INFO.Reverse it by pointing
readmeback atREADME.mdif you'd rather PyPI be Korean too.Validation
Links, anchors, HTML balance and character sets checked across all four files;
also asserted that no file still references the old
README.ko.md. Package builds.Known consequence
The Korean README is the four-section overview, so the repository's front page is
now a summary that defers to
README.en.mdfor benchmarks, architecture rationale,API reference and packaging. If you want Korean to carry the full documentation
instead, that's a larger translation — say the word.
🤖 Generated with Claude Code