Skip to content

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dowithless
Copy link

@dowithless dowithless commented Jun 16, 2025

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:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added/updated unit tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Documentation
    • Added a centered paragraph in the README with direct links to automatically updated translations in multiple languages, including German, Spanish, French, Japanese, Korean, Portuguese, Russian, and Chinese.

Added language selection links to the README for easier access to translated versions: German, Spanish, French, Japanese, Korean, Portuguese, Russian, and Chinese.
Copy link
Contributor

coderabbitai bot commented Jun 16, 2025

Walkthrough

A 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

Files Change Summary
README.md Added centered paragraph with links to translated README versions in multiple languages.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Timeout setting (#123) The change only affects the README and does not address timeout settings.

Poem

In README’s garden, new links bloom bright,
Languages gathered, a colorful sight.
From German to Chinese, translations appear,
Making the docs more friendly and clear.
A hop and a skip, the rabbit approves—
Sharing the code, across global grooves!
🐇🌍📖


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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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 adding target="_blank" with rel="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.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b4bb0cc and 742bf81.

📒 Files selected for processing (1)
  • README.md (1 hunks)

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