Skip to content

docs: add chinese README.zh.md#713

Open
lemon-little wants to merge 2 commits intoobra:mainfrom
lemon-little:main
Open

docs: add chinese README.zh.md#713
lemon-little wants to merge 2 commits intoobra:mainfrom
lemon-little:main

Conversation

@lemon-little
Copy link

Summary

Add Chinese translation of README (README.zh.md) and link it from the main README.

Motivation and Context

Not all users are comfortable reading English documentation. A Chinese translation lowers the barrier to entry for Chinese-speaking developers who want to use Superpowers, making the project more accessible to a wider audience.

How Has This Been Tested?

  • Verified that README.zh.md renders correctly with proper Markdown formatting
  • Verified that the [中文文档](README.zh.md) link in README.md resolves correctly to the new file
  • Confirmed that all sections, code blocks, and hyperlinks in the Chinese version match the English original

Breaking Changes

None. This is a purely additive change — existing files are not modified except for a single line added to README.md.

Types of changes

  • Documentation update

Checklist

  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added or updated documentation as needed

Additional context

The Chinese README (README.zh.md) is a full, faithful translation of the English README.md as of the current version. All technical terms (skill names, CLI commands, file paths, and external links) are kept in their original form to avoid ambiguity. The translation covers every section: installation instructions, basic workflow, skills library, philosophy, contributing guide, and support links.

@coderabbitai
Copy link

coderabbitai bot commented Mar 13, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 1efd0fc0-bd71-489e-a339-07e343e0aba1

📥 Commits

Reviewing files that changed from the base of the PR and between e72e81d and e810c25.

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

📝 Walkthrough

Walkthrough

Added a new Chinese-language README file (README.zh.md) and inserted a link to it near the top of the main README.md. No code or API changes; documentation-only updates.

Changes

Cohort / File(s) Summary
Main README update
README.md
Inserted a link to the Chinese documentation (README.zh.md) near the top and adjusted surrounding blank lines.
Chinese documentation added
README.zh.md
New comprehensive Chinese README covering installation, workflow stages, core skills, contribution guidelines, and related guidance (~180 lines added).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped in bytes and found a thread,

翻译一页,又添新页,
I placed a link where readers tread,
New README zh blooms, warm and bright,
Docs now greet both day and night.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title 'docs: add chinese README.zh.md' clearly and concisely describes the main change: adding a Chinese README translation file.
Description check ✅ Passed The pull request description is comprehensive and directly related to the changeset, explaining the motivation, testing approach, and confirming that the changes match the objectives of adding a Chinese README translation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Tip

CodeRabbit can suggest fixes for GitHub Check annotations.

Configure the reviews.tools.github-checks setting to adjust the time to wait for GitHub Checks to complete.

Copy link

@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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.zh.md`:
- Around line 69-71: The two unlabeled fenced code blocks containing the
INSTALL.md URLs should be labeled to satisfy markdownlint MD040; update each
triple-backtick opening (the blocks that wrap the URLs referencing
.codex/INSTALL.md and .opencode/INSTALL.md) to use a language tag (e.g.,
```text) so the blocks become ```text ... ``` in README.zh.md.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 36a805c2-8b43-4ea9-a035-f78b81d16887

📥 Commits

Reviewing files that changed from the base of the PR and between 363923f and e72e81d.

📒 Files selected for processing (2)
  • README.md
  • README.zh.md

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