-
Notifications
You must be signed in to change notification settings - Fork 4.8k
docs: add links to other language versions of README #1223
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
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 paragraph was added below the main badge and shield section in the README file, providing direct links to automatically updated translations of the README in several languages. No other files or code functionality were changed. Changes
Assessment against linked issues
Poem
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
22-32
: Localization links added correctly
Great addition to improve accessibility for non-English speakers.Nitpick: Consistency & link behavior
For consistency and UX/security, consider capitalizing “Français” to match the other language names, and addingtarget="_blank"
withrel="noopener noreferrer"
on each<a>
tag so translations open in a new tab safely.Proposed diff:
<p align="center"> <!-- Keep these links. Translations will automatically update with the README. --> - <a href="https://www.readme-i18n.com/unclecode/crawl4ai?lang=de">Deutsch</a> | + <a href="https://www.readme-i18n.com/unclecode/crawl4ai?lang=de" target="_blank" rel="noopener noreferrer">Deutsch</a> | - <a href="https://www.readme-i18n.com/unclecode/crawl4ai?lang=fr">français</a> | + <a href="https://www.readme-i18n.com/unclecode/crawl4ai?lang=fr" target="_blank" rel="noopener noreferrer">Français</a> |Apply the same pattern to the other language links.
Allowing users around the world to read the documentation in their native languages — including German, Spanish, French, Japanese, Korean, Portuguese, Russian, and Chinese.
This update improves accessibility and project understanding for non-English speakers around the world.
The updated links can be previewed in my forked repository: https://github.com/dowithless/crawl4ai/tree/patch-1
Summary
Please include a summary of the change and/or which issues are fixed.
eg:
Fixes #123
(Tag GitHub issue numbers in this format, so it automatically links the issues with your PR)List of files changed and why
eg: quickstart.py - To update the example as per new changes
How Has This Been Tested?
Please describe the tests that you ran to verify your changes.
Checklist:
Summary by CodeRabbit