Docs/i18n batch c1 developing foundation#2504
Conversation
Translates 6 core developer-facing documents into Simplified Chinese: - getting-set-up.md (environment setup) - architecture.md (deep architecture reference) - architecture/README.md (architecture overview) - building-rust-core.md (Rust core build guide) - testing-strategy.md (testing strategy) - e2e-testing.md (E2E testing guide) Links localized where .zh-CN.md target exists. Opening fences use ```text, closing fences use ```.
- 为全部 6 个翻译文件补充 frontmatter lang: zh-CN - 修复 building-rust-core.zh-CN.md 中指向不存在的 README.zh-CN.md 的链接 → 更正为 architecture/README.zh-CN.md - 术语一致性、closing fence、链接本地化均已验证通过
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✅ Files skipped from review due to trivial changes (5)
📝 WalkthroughWalkthroughThis PR adds comprehensive Chinese-language documentation across six files: high-level architecture and component design, Rust core build instructions, desktop application setup and installation guide, E2E testing with WDIO and Tauri, and testing strategy with coverage requirements and mock protocols. ChangesOpenHuman Chinese Developer Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
- token: 统一保留英文,移除'令牌'译法(5处) → 登录 token、刷新 token、签发 token - agent: 统一译为'智能体',移除'代理'译法(2处) → 网页搜索智能体、工具智能体 - 与 features 批次及 terminology-zh-CN.md 保持一致
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (8)
gitbooks/developing/architecture.zh-CN.md (7)
144-165: ⚡ Quick winAdd language identifier to ASCII diagram code fence.
Specify
textas the language for this ASCII diagram to meet markdown formatting standards.📝 Proposed fix
-``` +```text +---------------------------------------------------------------+ | RuntimeEngine |🤖 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 `@gitbooks/developing/architecture.zh-CN.md` around lines 144 - 165, The ASCII diagram code fence lacks a language identifier; update the opening triple-backtick for the diagram that starts with the "RuntimeEngine" header to use a text language specifier (change ``` to ```text) so the block is treated as plain text; look for the diagram containing "RuntimeEngine", "SkillRegistry", "CronScheduler", and the ASCII box art and add the language tag to that code fence.
259-275: ⚡ Quick winAdd language identifier to ASCII diagram code fence.
Use
textas the language identifier for this security architecture diagram.📝 Proposed fix
-``` +```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 `@gitbooks/developing/architecture.zh-CN.md` around lines 259 - 275, The ASCII diagram code fence is missing a language identifier; change the opening triple-backtick fence for the security-layer diagram from ``` to ```text so the diagram is treated as plain text (look for the ASCII block starting with the +-------------------------------------------------------------------+ line and update its opening fence to include the text identifier).
210-236: ⚡ Quick winAdd language identifier to ASCII diagram code fence.
Add
textas the language identifier for this ASCII flow diagram.📝 Proposed fix
-``` +```text 用户提示 | v🤖 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 `@gitbooks/developing/architecture.zh-CN.md` around lines 210 - 236, The code fence containing the ASCII flow diagram should include a language identifier to ensure correct rendering; update the opening backticks for the diagram snippet (the triple backtick block that begins before "用户提示" and ends after "AI 对用户的响应") to use ```text instead of just ```, keeping the diagram content unchanged so the block reads ```text ... ```; no other changes needed.
35-43: ⚡ Quick winAdd language identifier to ASCII diagram code fence.
Markdown best practice and linting tools expect all fenced code blocks to specify a language identifier. For ASCII diagrams, use
text.📝 Proposed fix
-``` +```text OpenHuman(已发布) | Desktop🤖 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 `@gitbooks/developing/architecture.zh-CN.md` around lines 35 - 43, The fenced ASCII diagram block lacks a language identifier; update the opening triple-backtick for the diagram (the fenced code block that contains the "OpenHuman(已发布) / Desktop / Windows macOS Linux" ASCII art) to include the language token `text` (i.e., change ``` to ```text) so markdown linters and renderers treat it as plain text.
291-326: ⚡ Quick winAdd language identifier to ASCII diagram code fence.
Specify
textas the language for this end-to-end data flow diagram.📝 Proposed fix
-``` +```text 用户在聊天 UI 中输入命令 | v🤖 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 `@gitbooks/developing/architecture.zh-CN.md` around lines 291 - 326, The ASCII diagram code fence is missing a language identifier; update the triple-backtick block that surrounds the end-to-end flow diagram (the block starting with "用户在聊天 UI 中输入命令" and ending with "用户在聊天界面中看到结果") to use ```text as the opener so the fence reads ```text and the closing ``` remains unchanged, ensuring the diagram is tagged as plain text for proper rendering.
109-125: ⚡ Quick winAdd language identifier to ASCII diagram code fence.
Use
textas the language identifier for ASCII diagrams to satisfy markdown linting requirements.📝 Proposed fix
-``` +```text 桌面模式: Web 模式: +-------------+ +-------------+🤖 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 `@gitbooks/developing/architecture.zh-CN.md` around lines 109 - 125, The Markdown code fence containing the ASCII diagram is missing a language identifier; update the opening fence (the triple backticks before the diagram that starts with "桌面模式: Web 模式:") to use the `text` language identifier (i.e., change ``` to ```text) so the ASCII diagram adheres to markdown linting rules and renders as plain text.
51-80: ⚡ Quick winAdd language identifier to ASCII diagram code fence.
Markdown best practice requires a language identifier for all fenced code blocks. Use
textfor ASCII diagrams.📝 Proposed fix
-``` +```text +------------------------------------------------------------------+ | React 前端 |🤖 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 `@gitbooks/developing/architecture.zh-CN.md` around lines 51 - 80, The ASCII diagram fenced block that begins with the line "+------------------------------------------------------------------+" is missing a language identifier; update the opening fence from ``` to ```text so the diagram is marked as plain text (e.g., change the code block that contains the React 前端 / Rust 核心引擎 ASCII diagram to use ```text).gitbooks/developing/architecture/README.zh-CN.md (1)
16-39: ⚡ Quick winAdd language identifier to ASCII diagram code fence.
Markdown linting tools require all fenced code blocks to specify a language. Use
textfor ASCII diagrams.📝 Proposed fix
-``` +```text ┌──────────────────────────────────────────────────┐ │ Tauri 壳层 (app/src-tauri/) │🤖 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 `@gitbooks/developing/architecture/README.zh-CN.md` around lines 16 - 39, The fenced ASCII diagram block is missing a language identifier which fails markdown linting; update the opening triple-backtick for the diagram to include "text" (i.e. change ``` to ```text) so the diagram code fence is explicitly marked as plain text and linting passes, targeting the ASCII diagram code block shown in the diff.
🤖 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 `@gitbooks/developing/building-rust-core.zh-CN.md`:
- Around line 124-126: The code fence containing the error message "fatal error:
'array' file not found" lacks a language specifier; update that fenced block
(the triple-backtick block that wraps that error string) to include the language
tag "text" (i.e., change ``` to ```text) so the output/error block follows the
repo's formatting conventions.
In `@gitbooks/developing/e2e-testing.zh-CN.md`:
- Line 243: The link in gitbooks/developing/e2e-testing.zh-CN.md that references
"AGENT-OBSERVABILITY.md" is broken because that file is not in the same
directory; locate the markdown link in e2e-testing.zh-CN.md that points to
./AGENT-OBSERVABILITY.md, search the repo for the actual location or canonical
slug of AGENT-OBSERVABILITY.md, and update the link to the correct relative path
or absolute URL; if the target file does not exist, either point the link to the
correct documentation page (e.g., the observability doc) or remove/replace the
link with the appropriate existing resource so the reference is not broken.
In `@gitbooks/developing/getting-set-up.zh-CN.md`:
- Around line 201-207: The code fence containing the OpenHuman CEF cache error
block is missing a language specifier; update the triple-backtick fence that
surrounds the log/error output so it reads "```text" at the opening fence (leave
the closing fence as "```") to follow the PR's formatting conventions and ensure
the block is treated as plain text.
---
Nitpick comments:
In `@gitbooks/developing/architecture.zh-CN.md`:
- Around line 144-165: The ASCII diagram code fence lacks a language identifier;
update the opening triple-backtick for the diagram that starts with the
"RuntimeEngine" header to use a text language specifier (change ``` to ```text)
so the block is treated as plain text; look for the diagram containing
"RuntimeEngine", "SkillRegistry", "CronScheduler", and the ASCII box art and add
the language tag to that code fence.
- Around line 259-275: The ASCII diagram code fence is missing a language
identifier; change the opening triple-backtick fence for the security-layer
diagram from ``` to ```text so the diagram is treated as plain text (look for
the ASCII block starting with the
+-------------------------------------------------------------------+ line and
update its opening fence to include the text identifier).
- Around line 210-236: The code fence containing the ASCII flow diagram should
include a language identifier to ensure correct rendering; update the opening
backticks for the diagram snippet (the triple backtick block that begins before
"用户提示" and ends after "AI 对用户的响应") to use ```text instead of just ```, keeping
the diagram content unchanged so the block reads ```text ... ```; no other
changes needed.
- Around line 35-43: The fenced ASCII diagram block lacks a language identifier;
update the opening triple-backtick for the diagram (the fenced code block that
contains the "OpenHuman(已发布) / Desktop / Windows macOS Linux" ASCII art) to
include the language token `text` (i.e., change ``` to ```text) so markdown
linters and renderers treat it as plain text.
- Around line 291-326: The ASCII diagram code fence is missing a language
identifier; update the triple-backtick block that surrounds the end-to-end flow
diagram (the block starting with "用户在聊天 UI 中输入命令" and ending with
"用户在聊天界面中看到结果") to use ```text as the opener so the fence reads ```text and the
closing ``` remains unchanged, ensuring the diagram is tagged as plain text for
proper rendering.
- Around line 109-125: The Markdown code fence containing the ASCII diagram is
missing a language identifier; update the opening fence (the triple backticks
before the diagram that starts with "桌面模式: Web 模式:") to
use the `text` language identifier (i.e., change ``` to ```text) so the ASCII
diagram adheres to markdown linting rules and renders as plain text.
- Around line 51-80: The ASCII diagram fenced block that begins with the line
"+------------------------------------------------------------------+" is
missing a language identifier; update the opening fence from ``` to ```text so
the diagram is marked as plain text (e.g., change the code block that contains
the React 前端 / Rust 核心引擎 ASCII diagram to use ```text).
In `@gitbooks/developing/architecture/README.zh-CN.md`:
- Around line 16-39: The fenced ASCII diagram block is missing a language
identifier which fails markdown linting; update the opening triple-backtick for
the diagram to include "text" (i.e. change ``` to ```text) so the diagram code
fence is explicitly marked as plain text and linting passes, targeting the ASCII
diagram code block shown in the diff.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 63778005-da52-4d55-a0d5-363b5ac2e99e
📒 Files selected for processing (6)
gitbooks/developing/architecture.zh-CN.mdgitbooks/developing/architecture/README.zh-CN.mdgitbooks/developing/building-rust-core.zh-CN.mdgitbooks/developing/e2e-testing.zh-CN.mdgitbooks/developing/getting-set-up.zh-CN.mdgitbooks/developing/testing-strategy.zh-CN.md
- 10 个纯文本代码块补充 opening fence 语言标识符
→ architecture.zh-CN.md (7), architecture/README.zh-CN.md (1),
building-rust-core.zh-CN.md (1), getting-set-up.zh-CN.md (1)
- 修复 e2e-testing.zh-CN.md 中大小写错误的链接
→ AGENT-OBSERVABILITY.md → agent-observability.md(Linux 区分大小写)
Co-authored-by: agent:skill-master <skill-master@openclaw>
Summary
gitbooks/developing/下 6 个核心开发文档翻译为简体中文(zh-CN),降低中文开发者的阅读门槛。lang: zh-CN,确保 GitBook 多语言渲染正确识别。architecture/README.zh-CN.md),外部无翻译文档保持英文原链。terminology-zh-CN.md),确保Agent Harness、Tauri Shell、CEF等技术模块名保留英文,frontend→前端、shell→壳层、core→核心等通用术语译法一致。Problem
OpenHuman 的开发者文档目前仅有英文版本,中文贡献者需要直接阅读英文原文才能了解环境搭建、架构总览、构建流程和测试策略。这提高了中文开发者的参与门槛,也可能因术语理解不一致导致 build/test 过程中的沟通成本。
Solution
getting-set-up.zh-CN.md— 环境搭建与安装architecture.zh-CN.md— 深度架构参考architecture/README.zh-CN.md— 架构子目录概览building-rust-core.zh-CN.md— Rust 核心构建testing-strategy.zh-CN.md— 测试策略e2e-testing.zh-CN.md— E2E 测试指南.zh-CN.md;指向外部无翻译文档(如AGENTS.md、PROMPT_INJECTION_GUARD.md、TEST-COVERAGE-MATRIX.md)的链接保留英文原版,避免死链。```text/ closing fence```格式正确;验证 frontmatter 完整性。Submission Checklist
diff-cover) meet the gate enforced by.github/workflows/coverage.yml. Runpnpm test:coverageandpnpm test:rustlocally; PRs below 80% on changed lines will not merge.docs/TEST-COVERAGE-MATRIX.mdreflect this change (orN/A: behaviour-only change)## Relateddocs/RELEASE-MANUAL-SMOKE.md)Closes #NNNin the## RelatedsectionImpact
.zh-CN.md翻译文件,未修改任何源代码、构建配置或运行时行为。lang标记渲染对应语言版本。Related
frontend.md,tauri-shell.md,agent-harness.md,desktop-companion.md,agent-observability.md,cef.md,mcp-server.md,release-policy.md,polymarket.mdfrontend.zh-CN.md等文件创建后,C1 的architecture.zh-CN.md中指向这些文件的英文链接可升级为.zh-CN.mdAI Authored PR Metadata (required for Codex/Linear PRs)
Linear Issue
Commit & Branch
docs/i18n-batch-c1-developing-foundation2fa36ca1Validation Run
pnpm --filter openhuman-app format:checkpnpm typecheckValidation Blocked
command:N/Aerror:N/Aimpact:N/ABehavior Changes
Parity Contract
Duplicate / Superseded PR Handling
Summary by CodeRabbit