docs: add Chinese (zh-CN) translation of README#2259
Closed
ruguoba wants to merge 4 commits into
Closed
Conversation
github-actions
Bot
added
the
documentation
Contributor
WalkthroughAdds a language selector to README.md and adds a new, comprehensive Chinese README (README_zh.md) with badges, announcement, feature overview, quick start, docs/data-source listings, repository structure, community info, and license/contributor details. ChangesChinese README Localization
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README_zh.md`:
- Line 5: Three <img> tags are missing alt attributes causing
accessibility/MD045 failures; update each <img> tag (including the one with
src="./misc/wrenai_logo_white.png" and the other two images referenced at the
same locations) to include a concise, descriptive alt attribute (e.g.,
alt="WrenAI logo" or an appropriate description for each image) so screen
readers and markdownlint MD045 are satisfied; ensure you add meaningful alt text
rather than empty strings unless the image is purely decorative.
- Line 27: The aria-label on the anchor element with
href="https://discord.gg/5DvshJqG8Z" is incorrect ("Join the community on
GitHub"); update that aria-label to accurately reflect the destination (e.g.,
"Join the community on Discord") so assistive technologies convey the correct
link target; locate the anchor tag in README_zh.md containing aria-label and the
Discord href and replace the label text accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: c00d2f9f-90f5-434e-be0b-832eb4f86a7c
📒 Files selected for processing (2)
README.mdREADME_zh.md
| <a href="https://getwren.ai/?utm_source=github&utm_medium=title&utm_campaign=readme"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: light)" srcset="./misc/wrenai_logo.png"> | ||
| <img src="./misc/wrenai_logo_white.png" width="300px"> |
Contributor
There was a problem hiding this comment.
Add missing alt text to images (Line 5, Line 31, Line 135).
These <img> tags are missing alt, which hurts screen-reader accessibility and triggers markdownlint MD045.
Suggested patch
- <img src="./misc/wrenai_logo_white.png" width="300px">
+ <img src="./misc/wrenai_logo_white.png" width="300px" alt="WrenAI logo">
...
- <img src="https://img.shields.io/badge/%F0%9F%A7%A1-Made%20by%20Canner-blue?style=for-the-badge">
+ <img src="https://img.shields.io/badge/%F0%9F%A7%A1-Made%20by%20Canner-blue?style=for-the-badge" alt="Made by Canner badge">
...
- <img src="https://contrib.rocks/image?repo=Canner/WrenAI" />
+ <img src="https://contrib.rocks/image?repo=Canner/WrenAI" alt="Project contributors" />Also applies to: 31-31, 135-135
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 5-5: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README_zh.md` at line 5, Three <img> tags are missing alt attributes causing
accessibility/MD045 failures; update each <img> tag (including the one with
src="./misc/wrenai_logo_white.png" and the other two images referenced at the
same locations) to include a concise, descriptive alt attribute (e.g.,
alt="WrenAI logo" or an appropriate description for each image) so screen
readers and markdownlint MD045 are satisfied; ensure you add meaningful alt text
rather than empty strings unless the image is purely decorative.
Author
|
Thank you for the review! I have fixed all the issues:
Please let me know if there are any other changes needed! |
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (1)
README_zh.md (1)
135-135:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd missing
alttext to contributors image.The contributors image at line 135 is still missing the
altattribute, which was flagged in the previous review. This affects accessibility for screen readers.♿ Proposed fix
- <img src="https://contrib.rocks/image?repo=Canner/WrenAI" /> + <img src="https://contrib.rocks/image?repo=Canner/WrenAI" alt="Project contributors" />🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README_zh.md` at line 135, The contributors image tag (<img src="https://contrib.rocks/image?repo=Canner/WrenAI" />) is missing an alt attribute; update that <img> element in README_zh.md to include a meaningful alt text (e.g., alt="Contributors") so screen readers can describe the image, ensuring the tag becomes <img src="https://contrib.rocks/image?repo=Canner/WrenAI" alt="Contributors" /> (or another appropriate descriptive string).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@README_zh.md`:
- Line 135: The contributors image tag (<img
src="https://contrib.rocks/image?repo=Canner/WrenAI" />) is missing an alt
attribute; update that <img> element in README_zh.md to include a meaningful alt
text (e.g., alt="Contributors") so screen readers can describe the image,
ensuring the tag becomes <img
src="https://contrib.rocks/image?repo=Canner/WrenAI" alt="Contributors" /> (or
another appropriate descriptive string).
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
README_zh.md (1)
135-135: ⚡ Quick winImprove the alt text for better accessibility.
The contributors image uses generic alt text
"image". While this satisfies the technical requirement for alt attributes, it doesn't provide meaningful information to screen reader users.♻️ Suggested improvement
- <img alt="image" src="https://contrib.rocks/image?repo=Canner/WrenAI" /> + <img alt="Project contributors" src="https://contrib.rocks/image?repo=Canner/WrenAI" />🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README_zh.md` at line 135, The image tag in README_zh.md uses a non-descriptive alt text ("image"); update the alt attribute on the <img> element (the line with <img alt="image" src="https://contrib.rocks/image?repo=Canner/WrenAI" />) to a meaningful description such as "Contributors to the WrenAI repository" or "WrenAI contributors graph" so screen readers convey useful context.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@README_zh.md`:
- Line 135: The image tag in README_zh.md uses a non-descriptive alt text
("image"); update the alt attribute on the <img> element (the line with <img
alt="image" src="https://contrib.rocks/image?repo=Canner/WrenAI" />) to a
meaningful description such as "Contributors to the WrenAI repository" or
"WrenAI contributors graph" so screen readers convey useful context.
Author
|
Closing this PR to clean up my contribution queue. Thank you for your time. |
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.
添加 README 的中文翻译版本。
Changes
Motivation
让更多中文开发者能够更好地了解和使用 WrenAI 项目。
Summary by CodeRabbit