Skip to content

docs(zh-CN): sync outdated/missing sections with English README#1562

Closed
hjick wants to merge 1 commit into
affaan-m:mainfrom
hjick:docs/sync-zh-CN-v1.10
Closed

docs(zh-CN): sync outdated/missing sections with English README#1562
hjick wants to merge 1 commit into
affaan-m:mainfrom
hjick:docs/sync-zh-CN-v1.10

Conversation

@hjick
Copy link
Copy Markdown

@hjick hjick commented Apr 23, 2026

Summary

Brings the Simplified Chinese docs/zh-CN/README.md closer to the current English README by inserting new sections while preserving existing Chinese wording. Same surgical approach as #1560 (ko-KR) and #1561 (ja-JP).

What changed

What's New

  • Added v1.10.0 (Apr 2026) — dashboard GUI, surface sync, operator/outbound workflows, ECC 2.0 alpha

Quick Start

  • Step 1: added NOTE about plugin vs OSS installer path
  • New subsection: 命名 + 迁移说明 — explains the three public identifiers (repo / marketplace-plugin / npm)
  • Step 3: added "skills are primary workflow surface" framing; wording refined to "79 个 legacy 命令 shim"
  • New subsection: Dashboard GUI (Tkinter) with launch commands and feature list
  • New subsection: 多模型命令需要额外设置ccg-workflow runtime warning for multi-* commands

Scope intentionally limited

Existing Chinese paragraphs preserved verbatim; this PR only inserts missing content. zh-CN was already mostly up-to-date (Step 1 command already correct, Step 3 counts already current) so the diff is smaller than ko-KR/ja-JP.

Other English-only sections still missing (Cursor/Codex/OpenCode/Cross-Tool Feature Parity/Background/Community Projects) left for follow-up PRs.

Test plan

  • Markdown renders on GitHub preview
  • Relative links resolve from docs/zh-CN/
  • No existing Chinese sentences reworded
  • Preserves existing terminology (智能体, 技能, 钩子, 插件, 市场, 本能)
  • Diff is +57 / -1 lines, additive

Related

Summary by CodeRabbit

  • Documentation
    • Updated Chinese documentation for v1.10.0 release
    • Added Desktop Dashboard GUI description and launch instructions
    • Documented ECC 2.0 Alpha with Rust control-plane commands and build guidance
    • Enhanced quick-start flow with installation recommendations and dependency warnings about command availability in baseline setup

Summary by cubic

Syncs docs/zh-CN/README.md with the English README by inserting v1.10.0 highlights and Quick Start additions. Adds Dashboard GUI usage, clarifies public identifiers, and notes extra setup for multi-* commands.

  • Docs Updates
    • Added “What’s New” for v1.10.0: Tkinter Dashboard, surface sync, ops workflows, ECC 2.0 alpha.
    • Quick Start: added note on plugin vs OSS installer; new “命名 + 迁移说明” for affaan-m/everything-claude-code, everything-claude-code@everything-claude-code, and ecc-universal.
    • Quick Start: added Dashboard launch commands (npm run dashboard, ecc_dashboard.py); clarified Step 3 (“skills are primary,” “79 个 legacy 命令 shim”); warning that multi-* commands require the ccg-workflow runtime (npx ccg-workflow).
    • Insert-only changes; existing Chinese text preserved.

Written for commit aa8ee21. Summary will update on new commits.

Insert-only approach that preserves existing Chinese wording:

- What's New: add v1.10.0 (Apr 2026) changelog entry
- Quick Start Step 1: new NOTE about plugin vs OSS installer
- Quick Start: new '命名 + 迁移说明' subsection explaining the three
  public identifiers (repo/marketplace/npm)
- Quick Start Step 3: add 'skills are primary workflow surface'
  framing; refine component wording to '79 个 legacy 命令 shim'
- Quick Start: new 'Dashboard GUI' subsection (Tkinter desktop app)
- Quick Start: new '多模型命令需要额外设置' warning block for
  ccg-workflow runtime

Does not touch existing Chinese paragraphs. Larger English-only
sections (Cursor/Codex/OpenCode/Cross-Tool Feature Parity/Background/
Community Projects) left for follow-up PRs.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 23, 2026

📝 Walkthrough

Walkthrough

Updates the Simplified Chinese README documentation to version 1.10.0, introducing Desktop Dashboard GUI (Tkinter) features, ECC 2.0 Alpha with Rust control-plane commands, expanded operational workflow components, revised installer guidance, and clarified command shim and multi-* command setup requirements.

Changes

Cohort / File(s) Summary
Chinese Documentation Update
docs/zh-CN/README.md
Adds Desktop Dashboard GUI description, documents ECC 2.0 Alpha features with Rust commands, updates quick-start installation guidance with OSS installer preferences, clarifies ECC naming/migration identifiers, modifies success messaging to emphasize legacy command shims, and includes dependency warnings about multi-\* commands requiring ccg-workflow initialization.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • PR #1291: Updates Simplified Chinese README with installation/usage guidance and multi-\* commands documentation similar to this PR.
  • PR #1544: Modifies docs/zh-CN/README.md to clarify installer vs plugin installation behavior and naming guidance.
  • PR #107: Updates Chinese README localization with docs/zh-CN content additions.

Suggested reviewers

  • affaan-m

Poem

🐰 Hops with glee through docs so bright,
Dashboard buttons, ECC in sight,
Chinese guides now gleaming new,
v1.10.0 shines right through!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically summarizes the main change: synchronizing the Chinese documentation with the English README by adding missing sections.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 23, 2026

Greptile Summary

This PR syncs the Simplified Chinese README with the English README by inserting the v1.10.0 changelog entry, a plugin-vs-OSS installer NOTE, a naming/migration subsection, Dashboard GUI instructions, and a multi-model setup warning — all as additive insertions without rewording existing Chinese text.

One documentation inconsistency was introduced: the new v1.10.0 bullet cites 38 agents / 156 skills / 72 commands as the post-sync counts, while the existing "搞定!" line (also modified in this PR) and the cross-platform feature table both continue to read 48 agents / 183 skills / 79 commands. The correct figures should be reconciled before merge to avoid reader confusion.

Confidence Score: 5/5

Safe to merge; all changes are purely additive documentation with one minor count inconsistency that does not affect functionality.

The only finding is a P2 documentation inconsistency (conflicting component counts between the new v1.10.0 bullet and the existing Quick Start/feature-parity table). No code is changed, no logic is affected, and the inconsistency does not block use of the plugin.

docs/zh-CN/README.md — reconcile the component counts (38/156/72 vs 48/183/79) between the v1.10.0 changelog bullet and the Quick Start / feature-parity table.

Important Files Changed

Filename Overview
docs/zh-CN/README.md Additive sync of v1.10.0 changelog, naming/migration notes, Dashboard GUI, and multi-model setup warning; introduces a minor count inconsistency between the new v1.10.0 bullet (38 agents/156 skills/72 commands) and the existing Quick Start and feature-parity table (48 agents/183 skills/79 commands).

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["Step 1: Install plugin\n/plugin marketplace add …\n/plugin install …"] --> NOTE["NOTE block\n(plugin vs OSS installer path)"]
    NOTE --> NM["命名 + 迁移说明\nGitHub / marketplace / npm identifiers"]
    NM --> B["Step 2: Install rules (required)"]
    B --> C["Step 3: Start using\nSkills are primary surface"]
    C --> DONE["搞定!\n48 agents · 183 skills · 79 legacy shims"]
    DONE --> DASH["Dashboard GUI\nnpm run dashboard / python3 ecc_dashboard.py"]
    DASH --> MULTI["多模型命令需要额外设置\nccg-workflow runtime required for multi-* commands"]
Loading

Reviews (1): Last reviewed commit: "docs(zh-CN): sync outdated sections with..." | Re-trigger Greptile

Comment thread docs/zh-CN/README.md
### v1.10.0 — 界面刷新、运营工作流与 ECC 2.0 Alpha(2026 年 4 月)

* **Dashboard GUI** — 全新基于 Tkinter 的桌面应用程序(`ecc_dashboard.py` 或 `npm run dashboard`),支持深色/浅色主题切换、字体自定义,以及页眉和任务栏中的项目 Logo。
* **公开界面与实际仓库同步** — 元数据、目录数量、插件清单与安装相关文档现已与实际 OSS 界面一致:38 个智能体、156 项技能、72 个 legacy 命令 shim。
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Count mismatch between v1.10.0 changelog and Quick Start

The newly added v1.10.0 bullet states the repo now has 38 个智能体、156 项技能、72 个 legacy 命令 shim, but the "搞定!" line on line 243 (also touched in this PR) still reads 48 个智能体、183 项技能和 79 个 legacy 命令 shim. The cross-platform feature-parity table (line 1159–1163) also uses the 48/79/183 figures. The two sets of counts are mutually contradictory and will confuse readers trying to understand what they actually get after installation.

Copy link
Copy Markdown
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: 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 `@docs/zh-CN/README.md`:
- Around line 179-188: The docs claim the plugin install entry is
everything-claude-code@everything-claude-code but later examples still show the
short form (/plugin install everything-claude-code); update all installation
examples and mentions in this file to use the canonical identifier
everything-claude-code@everything-claude-code (and keep npm references as
ecc-universal) so examples and prose are consistent and users aren’t guided to
the deprecated short alias.
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5480059e-dc51-43e7-97f1-d86dbf9a8f5b

📥 Commits

Reviewing files that changed from the base of the PR and between 4e66b28 and aa8ee21.

📒 Files selected for processing (1)
  • docs/zh-CN/README.md

Comment thread docs/zh-CN/README.md
Comment on lines +179 to +188
### 命名 + 迁移说明

ECC 现在有三个对外公开的标识符,且彼此不可互换:

- GitHub 源仓库:`affaan-m/everything-claude-code`
- Claude 市场/插件标识符:`everything-claude-code@everything-claude-code`
- npm 包:`ecc-universal`

这是有意设计。Anthropic 的市场/插件安装以规范的插件标识符为键,因此 ECC 将列表名称、`/plugin install`、`/plugin list` 和仓库文档统一指向同一个公开安装入口 `everything-claude-code@everything-claude-code`。旧帖子中可能仍然出现早期的短别称;该简写已弃用。另一方面,npm 包保留为 `ecc-universal`,因此 npm 安装与市场安装会有意使用不同的名称。

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

“标识符不可互换”与文档后文安装命令存在冲突。

这里声明插件安装入口统一为 everything-claude-code@everything-claude-code,但同一文件后文仍给出 /plugin install everything-claude-code。建议统一全文件示例,避免迁移用户按旧写法执行。

🛠️ 建议修正(同步后文安装示例)
-# Install the plugin
-/plugin install everything-claude-code
+# Install the plugin
+/plugin install everything-claude-code@everything-claude-code
🧰 Tools
🪛 LanguageTool

[grammar] ~186-~186: Ensure spelling is correct
Context: ...g-claude-code - npm 包:ecc-universal 这是有意设计。Anthropic 的市场/插件安装以规范的插件标识符为键,因此 ECC 将列表名称、/plug...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/zh-CN/README.md` around lines 179 - 188, The docs claim the plugin
install entry is everything-claude-code@everything-claude-code but later
examples still show the short form (/plugin install everything-claude-code);
update all installation examples and mentions in this file to use the canonical
identifier everything-claude-code@everything-claude-code (and keep npm
references as ecc-universal) so examples and prose are consistent and users
aren’t guided to the deprecated short alias.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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="docs/zh-CN/README.md">

<violation number="1" location="docs/zh-CN/README.md:87">
P2: README contains conflicting component-count expectations (38/156/72 vs 48/183/79) without clear scoping, which can mislead install verification.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

Comment thread docs/zh-CN/README.md
### v1.10.0 — 界面刷新、运营工作流与 ECC 2.0 Alpha(2026 年 4 月)

* **Dashboard GUI** — 全新基于 Tkinter 的桌面应用程序(`ecc_dashboard.py` 或 `npm run dashboard`),支持深色/浅色主题切换、字体自定义,以及页眉和任务栏中的项目 Logo。
* **公开界面与实际仓库同步** — 元数据、目录数量、插件清单与安装相关文档现已与实际 OSS 界面一致:38 个智能体、156 项技能、72 个 legacy 命令 shim。
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: README contains conflicting component-count expectations (38/156/72 vs 48/183/79) without clear scoping, which can mislead install verification.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At docs/zh-CN/README.md, line 87:

<comment>README contains conflicting component-count expectations (38/156/72 vs 48/183/79) without clear scoping, which can mislead install verification.</comment>

<file context>
@@ -81,6 +81,16 @@
+### v1.10.0 — 界面刷新、运营工作流与 ECC 2.0 Alpha(2026 年 4 月)
+
+* **Dashboard GUI** — 全新基于 Tkinter 的桌面应用程序(`ecc_dashboard.py` 或 `npm run dashboard`),支持深色/浅色主题切换、字体自定义,以及页眉和任务栏中的项目 Logo。
+* **公开界面与实际仓库同步** — 元数据、目录数量、插件清单与安装相关文档现已与实际 OSS 界面一致:38 个智能体、156 项技能、72 个 legacy 命令 shim。
+* **运营与对外工作流扩展** — `brand-voice`、`social-graph-ranker`、`connections-optimizer`、`customer-billing-ops`、`ecc-tools-cost-audit`、`google-workspace-ops`、`project-flow-ops`、`workspace-surface-audit` 进一步充实运营通道。
+* **媒体与发布工具** — `manim-video`、`remotion-video-creation` 以及升级后的社交发布界面,使技术讲解与发布内容成为同一系统的一部分。
</file context>
Fix with Cubic

@affaan-m
Copy link
Copy Markdown
Owner

Thanks for the PR. This has been idle for a while and is not merge-ready against the moving main branch, so I am closing it to keep the queue tractable. Reopen is welcome with a current rebase and focused scope; maintainers may also port the useful parts into a fresh PR where appropriate.

@affaan-m affaan-m closed this May 11, 2026
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.

2 participants