docs: Enhance README.zh-CN.md with badges and instructions#1291
docs: Enhance README.zh-CN.md with badges and instructions#1291affaan-m merged 4 commits intoaffaan-m:mainfrom
Conversation
Updated README.zh-CN.md to include additional badges, improved descriptions, and added new sections for installation and usage instructions.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughREADME.zh-CN.md updated with expanded badges and stats, revised install flows (OS-specific scripts and npx path), manual install and MCP guidance, new hook/runtime env vars, Claude Code CLI requirement, AgentShield docs, a rewritten repository tree, added community/sponsor sections, and updated links and guides. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
README.zh-CN.md (2)
87-87: 中文 README 中出现英文 NOTE，建议本地化统一Line 87 使用英文提示，和全文中文语境不一致。建议改为中文，降低阅读跳变。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.zh-CN.md` at line 87, Replace the English NOTE string "NOTE: The plugin is convenient, but the OSS installer below is still the most reliable path if your Claude Code build has trouble resolving self-hosted marketplace entries." with a natural Chinese localization that matches the document tone (e.g., "注意：该插件使用方便，但如果 Claude Code 构建在解析自托管市场条目时出现问题，下面的 OSS 安装器仍是最可靠的方案。") so the README.zh-CN.md content remains consistently Chinese.
18-18: 顶部手写统计数据容易过期，建议避免与徽章双轨维护Line 18 的固定数字后续容易与真实数据偏离，且上方已经有动态 badge。可以考虑删除该行或改为不含具体数值的描述。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.zh-CN.md` at line 18, Remove or replace the hard-coded stats line "> **140K+ stars** | **21K+ forks** | **170+ 贡献者** | **12+ 语言系统** | **Anthropic黑客松获胜者**" with a non-numeric, evergreen description (e.g. "活跃的开源项目，拥有广泛的社区贡献与多语言支持") or simply delete the line and rely on the existing dynamic badges so the README.zh-CN.md no longer contains time-sensitive fixed numbers.
🤖 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-CN.md`:
- Line 793: The link text "[安全指南]()" is an empty/ broken link; locate the
markdown token "[安全指南]()" and replace the empty target with the correct
documentation URL (or if no doc exists, remove the link and keep plain text
"安全指南" or add a valid placeholder URL like "#" and a TODO comment), ensuring the
link points to the intended security guide page rather than an image or empty
href.
- Around line 604-606: The documented copy commands reference a wrong path:
replace the first occurrence of "everything-claude-code/.agents/skills/*" with
the actual "everything-claude-code/skills/*" so both cp commands target the same
existing skills directory; update the README lines that contain those cp
commands to use "everything-claude-code/skills/*" and verify the second command
("everything-claude-code/skills/search-first") remains correct.
---
Nitpick comments:
In `@README.zh-CN.md`:
- Line 87: Replace the English NOTE string "NOTE: The plugin is convenient, but
the OSS installer below is still the most reliable path if your Claude Code
build has trouble resolving self-hosted marketplace entries." with a natural
Chinese localization that matches the document tone (e.g., "注意：该插件使用方便，但如果
Claude Code 构建在解析自托管市场条目时出现问题，下面的 OSS 安装器仍是最可靠的方案。") so the README.zh-CN.md
content remains consistently Chinese.
- Line 18: Remove or replace the hard-coded stats line "> **140K+ stars** |
**21K+ forks** | **170+ 贡献者** | **12+ 语言系统** | **Anthropic黑客松获胜者**" with a
non-numeric, evergreen description (e.g. "活跃的开源项目，拥有广泛的社区贡献与多语言支持") or simply
delete the line and rely on the existing dynamic badges so the README.zh-CN.md
no longer contains time-sensitive fixed numbers.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| cp -r everything-claude-code/.agents/skills/* ~/.claude/skills/ | ||
| cp -r everything-claude-code/skills/search-first ~/.claude/skills/ | ||
|
|
There was a problem hiding this comment.
skills 复制路径疑似写错，当前命令可能直接失败
Line 604 使用了 everything-claude-code/.agents/skills/*，但同一文档的目录结构写的是 skills/（非 .agents/skills）。这会导致用户按文档执行时报错。
建议修复
- cp -r everything-claude-code/.agents/skills/* ~/.claude/skills/
+ cp -r everything-claude-code/skills/* ~/.claude/skills/📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| cp -r everything-claude-code/.agents/skills/* ~/.claude/skills/ | |
| cp -r everything-claude-code/skills/search-first ~/.claude/skills/ | |
| cp -r everything-claude-code/skills/* ~/.claude/skills/ | |
| cp -r everything-claude-code/skills/search-first ~/.claude/skills/ | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.zh-CN.md` around lines 604 - 606, The documented copy commands
reference a wrong path: replace the first occurrence of
"everything-claude-code/.agents/skills/*" with the actual
"everything-claude-code/skills/*" so both cp commands target the same existing
skills directory; update the README lines that contain those cp commands to use
"everything-claude-code/skills/*" and verify the second command
("everything-claude-code/skills/search-first") remains correct.
Greptile SummaryThis PR substantially updates
Confidence Score: 5/5Documentation-only PR that is safe to merge; no code or configuration logic is changed. All changes are confined to README.zh-CN.md. The new content is accurate, mirrors the English README, references real scripts and files that exist in the repo, and the previously flagged issues appear resolved. No logic, security, or functional concerns remain. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[用户开始安装] --> B{使用插件系统?}
B -- 是 --> C["/plugin marketplace add\n/plugin install ecc@ecc"]
B -- 否 --> D[git clone 仓库]
C --> E[手动安装 rules/]
D --> F{操作系统?}
F -- macOS/Linux --> G["./install.sh --profile full"]
F -- Windows --> H[".\\install.ps1 --profile full"]
F -- 全平台 --> I[npx ecc-install typescript]
G --> J[完成: 47 代理 / 181 技能 / 79 命令]
H --> J
I --> J
E --> J
Reviews (3): Last reviewed commit: "Update security guide link in README.zh-..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 1 file
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="README.zh-CN.md">
<violation number="1" location="README.zh-CN.md:793">
P3: The “安全指南” link has an empty URL, so it renders as a broken link in the README. Provide a valid target or remove the link markup.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review, or fix all with cubic.
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
2 participants
Updated README.zh-CN.md to include additional badges, improved descriptions, and added new sections for installation and usage instructions.
What Changed
Only the Simplified Chinese version of the Readme file has been modified.
Added:
Updated:
Why This Change
I kept running into issues while trying to install this GitHub repository using my agent, and eventually found that the Simplified Chinese installation commands were outdated. To help more Chinese developers get started quickly, I updated them.
I also noticed that some of the latest changes hadn’t been synced, and important sections like Community Projects and Sponsors — which can significantly boost the project’s community visibility — were missing. I’ve updated those as well to help maintain the project’s presence. All updated content has been proofread word for word.
Testing Done
node tests/run-all.js)Type of Change
fix:Bug fixfeat:New featurerefactor:Code refactoringdocs:Documentationtest:Testschore:Maintenance/toolingci:CI/CD changesSecurity & Quality Checklist
Documentation
Summary by cubic
Updates the Simplified Chinese README with cross‑platform installers, multi‑IDE targets, stronger security docs/tools, and clearer setup. Also updates the Security Guide link and fixes outdated commands.
New Features
ecc-universal,ecc-agentshield), and GitHub App installs; Security Guide now links to./the-security-guide.md../install.shand./install.ps1with--profile/--target, plusnpx ecc-installfor Windows/macOS/Linux.ecc-agentshieldscan/--fix/--opus,init, and CI/GitHub Action integration; runtime controlsECC_HOOK_PROFILE,ECC_DISABLED_HOOKS, and MCP opt‑outECC_DISABLED_MCPS.Migration
"hooks"to.claude-plugin/plugin.json(hooks auto‑load); remove if present.Written for commit 21be9f8. Summary will update on new commits.
Summary by CodeRabbit