docs(readme): add multilingual translations and header badges#6
Merged
Conversation
Non-English users had only the English README to work from. Add fully translated versions for Simplified Chinese, Traditional Chinese, Japanese, Russian, and French under docs/README/, and wire them together with a language switcher at the top of each file. Also restructure the English header into a centered block and add CI, monthly-downloads, minzipped-size, and types badges alongside the existing npm and license badges, so the project's health and footprint are visible at a glance. Signed-off-by: Kevin Cui <bh@bugs.cc>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
Summary by CodeRabbit
WalkthroughThis pull request updates the main README.md header/badge block with a centered layout and additional badges (CI status, downloads, minzipped size, TypeScript types). It also adds five new complete localized README documentation pages (French, Japanese, Russian, Simplified Chinese, Traditional Chinese) under docs/README/, each covering the SDK overview, core concepts, configuration, error handling, recipes, ProjectConnector, OpenConnector, and licensing. No exported or public entity declarations are changed. Changes
Possibly related PRs
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✨ Finishing Touches✨ Simplify code
Comment |
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.
Non-English users had only the English README to work from. This adds fully translated READMEs for Simplified Chinese, Traditional Chinese, Japanese, Russian, and French under
docs/README/, each fronted by a language switcher so readers can jump between languages from any file.The English header is also restructured into a centered block with CI, monthly-downloads, minzipped-size, and types badges alongside the existing npm and license badges, surfacing the package's health and footprint at a glance.