-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add README.zh-TW.md: Add README Translation in Traditional Chinese #1400
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?
Add README.zh-TW.md: Add README Translation in Traditional Chinese #1400
Conversation
Corrected phrasing for clarity in the README.
Updated the README to provide English translations for various sections and improve clarity.
WalkthroughA new Traditional Chinese (zh-TW) localized README file was added to the Cap project, containing documentation about self-hosting, monorepo architecture, licensing, contributions, and analytics without modifying any existing code or logic. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Possibly related issues
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. 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 |
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: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.zh-TW.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.zh-TW.md
[uncategorized] ~71-~71: 您的意思是“"不"驟”?
Context: ...rd.co)。在執行 analytics:setup` 之前,請務必了解部署步驟具破壞性所帶來的影響並確認你能接受。
(BU)
🪛 markdownlint-cli2 (0.18.1)
README.zh-TW.md
5-5: Hard tabs
Column: 1
(MD010, no-hard-tabs)
6-6: Hard tabs
Column: 1
(MD010, no-hard-tabs)
7-7: Hard tabs
Column: 1
(MD010, no-hard-tabs)
13-13: Hard tabs
Column: 1
(MD010, no-hard-tabs)
23-23: Images should have alternate text (alt text)
(MD045, no-alt-text)
40-40: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🔇 Additional comments (3)
README.zh-TW.md (3)
40-40: Verify heading level structure.The markdown linter flagged an unexpected heading level jump at line 40 (MD001). The section "應用(Apps):" appears as a level 3 heading (###), but should likely be a level 2 (##) to maintain proper hierarchy after the "Monorepo 應用架構" h2 heading.
Please verify the intended heading structure. If line 40 should be a subsection, apply this diff:
-### 應用(Apps): +## 應用(Apps):Alternatively, if this should remain a level 3 heading, ensure the context level 2 heading precedes it without intermediate levels.
64-70: Verify analytics section wording for clarity.The analytics description at lines 64-70 is dense and contains complex nested instructions. Consider verifying that the wording accurately reflects the intended process, particularly around the
tb loginstep and the destructive-operations warning.Line 68 especially warrants review for clarity around the consequence of deployment ("它會把 Tinybird 工作區同步到
scripts/analytics/tinybird定義的資源,並移除該工作區中任何其他的資料來源/管線。").
1-70: Localization quality and content coverage look solid.The Traditional Chinese translation maintains good structure, provides all necessary information for self-hosting, architecture understanding, and contribution guidelines. The file successfully adapts the original README for a zh-TW audience.
| <p align="center"> | ||
| <img width="150" height="150" src="https://github.com/CapSoftware/Cap/blob/main/apps/desktop/src-tauri/icons/Square310x310Logo.png" alt="Logo"> | ||
| </p> | ||
| <h1 align="center"><b>Cap</b></h1> |
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.
🛠️ Refactor suggestion | 🟠 Major
Replace hard tabs with spaces.
Markdown linting best practices require spaces instead of hard tabs (MD010 violation). These tabs appear at the start of indented lines in the header section.
Apply this diff to replace hard tabs with spaces:
- <h1 align="center"><b>Cap</b></h1>
+ <h1 align="center"><b>Cap</b></h1>
- <p align="center">
+ <p align="center">
- Loom 的開源替代方案
+ Loom 的開源替代方案
- <a href="https://cap.so/download">macOS 與 Windows</a>
+ <a href="https://cap.so/download">macOS 與 Windows</a>Also applies to: 6-6, 7-7, 13-13
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
5-5: Hard tabs
Column: 1
(MD010, no-hard-tabs)
🤖 Prompt for AI Agents
In README.zh-TW.md around lines 5 to 5 (also apply to lines 6, 7 and 13),
replace the hard tab characters at the start of the header and those indented
lines with spaces to comply with MD010; edit each affected line to remove
leading tabs and use the equivalent number of spaces (preferably 2 or 4,
matching project style) so headers and indented lines are space-indented instead
of tab-indented.
|
As a Traditional Chinese user, I have reviewed the translated README.zh-TW.md and can confirm that there are no problems. |
curtis618
left a comment
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.
I have confirmed that there are no problems in README.zh-TW.md .
I adds a Traditional Chinese (zh-TW) version of the README file, providing localized documentation for users and contributors.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.