doc: Add links to translated README versions #449
Conversation
Added language selection links to the README for easier access to translated versions: German, Spanish, French, Japanese, Korean, Portuguese, Russian, and Chinese.
WalkthroughA centered HTML block with hyperlinks to translated versions of the README in eight different languages was added to the README.md file. No other files or logic were changed. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
30-40: Capitalize “Français” for visual consistencyEvery other language label starts with an uppercase letter, but “français” does not. Capitalizing it maintains a uniform look.
- <a href="https://readme-i18n.com/fr/srbhr/Resume-Matcher">français</a> | + <a href="https://readme-i18n.com/fr/srbhr/Resume-Matcher">Français</a> |
30-40: Consider addingtarget="_blank"+rel="noopener noreferrer"for the new external linksElsewhere in the README (e.g., line 26) external anchors open in a new tab and include the recommended
relattribute to avoidwindow.openerleaks. Applying the same attributes here keeps behaviour consistent and follows security best-practice.Illustrative example (apply to each anchor):
- <a href="https://readme-i18n.com/de/srbhr/Resume-Matcher">Deutsch</a> | + <a href="https://readme-i18n.com/de/srbhr/Resume-Matcher" target="_blank" rel="noopener noreferrer">Deutsch</a> |
|
I didn't know about this tool, it looks really good and the translation seems accurate. |
|
This is a nice way, however, I want docs written by people or at least reviewed and edited by humans so that the language is coherent. Also, all the README.xx.md should be present in the project. :) |
The readme-i18n translations are AI-generated, but they typically match or even exceed the quality of human-written translations in terms of language coherence. As for keeping all README.xx.md files in the project - we chose external linking because it provides a "set once and forget" solution that eliminates ongoing maintenance. However, we understand some teams prefer having docs in-repo. For those cases, readme-i18n does offer a download function where you can grab the translations, modify them as needed, and commit them to your project. |
3 participants
Added language selection links to the README for easier access to translated versions: German, Spanish, French, Japanese, Korean, Portuguese, Russian, and Chinese.
The updated links can be previewed in my forked repository: https://github.com/dowithless/Resume-Matcher/tree/patch-1
Pull Request Title
Related Issue
Description
Type
Proposed Changes
Screenshots / Code Snippets (if applicable)
How to Test
Checklist
Additional Information
Summary by CodeRabbit