Skip to content

docs: README translations into 10 more languages (19 in total), moved to docs/readme - #576

Open
MaksymStoianov wants to merge 4 commits into
developfrom
docs/readme-more-languages
Open

MaksymStoianov wants to merge 4 commits into
developfrom
docs/readme-more-languages

Conversation

@MaksymStoianov

@MaksymStoianov MaksymStoianov commented Nov 3, 2026 •

Copy link
Copy Markdown
Member

Adds README translations for ko, zh-TW, it, pl, tr, nl, id, vi, ar, cs (19 languages in total) and moves all translations to docs/readme/; the English README.md stays in the root.

  • Same language switcher in all 19 files (Simplified Chinese label «中文» → «简体中文»). Each translation carries the AI-assisted-translation note; not proofread by native speakers yet.
  • Arabic is right-to-left (<div dir="rtl" lang="ar"> around prose; code, badges and switcher stay LTR) — please glance at it on GitHub.
  • All relative links rewritten for the new folder: 948 links across 19 files, 0 broken. Fixed a pre-existing broken anchor in the English table of contents.
  • docs:check-i18n knows the new languages and folder and fails on broken relative links; CONTRIBUTING updated; docs.yml ignores docs/readme/**.
  • The npm package no longer ships the translations (22 → 4 files in a dry run without dist).

🤖 Generated with Claude Code

MaksymStoianov and others added 4 commits November 3, 2026 17:20
An Arabic translation wraps its prose in <div dir="rtl"> blocks, so the
translation note may follow such a wrapper line instead of the switcher
directly. Headings inside the wrappers keep counting as before.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Maksym Stoianov <stoianov.maksym@gmail.com>
… cs)

Translate the current README.md into Korean, Traditional Chinese (Taiwan),
Italian, Polish, Turkish, Dutch, Indonesian, Vietnamese, Arabic and Czech.
The switcher in every README now lists 19 languages, and the Simplified
Chinese entry is labelled 简体中文 next to 繁體中文. The Arabic README wraps
its prose in right-to-left blocks and keeps code, badges and the switcher
left to right.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Maksym Stoianov <stoianov.maksym@gmail.com>
The 18 README translations move from the repository root to docs/readme/,
so the root keeps only README.md (English) next to the project files. The
language switcher in README.md now links docs/readme/README.<lang>.md;
inside docs/readme/ the translations link each other by file name and
English as ../../README.md, and every other relative link is rewritten to
resolve from the new folder.

npm always packs root README* files, so the published package shipped all
translations; after the move it carries only README.md.

check-readme-translations.mjs reads the translations from docs/readme/,
expects the new switcher links and fails on any relative link whose
target does not exist. CONTRIBUTING describes the new paths, the docs workflow no longer runs
for changes under docs/readme/, and a stale anchor in the README table of
contents is fixed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Maksym Stoianov <stoianov.maksym@gmail.com>
@MaksymStoianov MaksymStoianov changed the title docs: README translations into 10 more languages (19 in total) docs: README translations into 10 more languages (19 in total), moved to docs/readme Nov 3, 2026

This branch has not been deployed

No deployments
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