Skip to content

docs(i18n): add zh-CN translations for legal docs, README, and SUMMAR…#2524

Open
JAYcodr wants to merge 1 commit into
tinyhumansai:mainfrom
JAYcodr:docs/i18n-batch-e-legal-and-home
Open

docs(i18n): add zh-CN translations for legal docs, README, and SUMMAR…#2524
JAYcodr wants to merge 1 commit into
tinyhumansai:mainfrom
JAYcodr:docs/i18n-batch-e-legal-and-home

Conversation

@JAYcodr
Copy link
Copy Markdown
Contributor

@JAYcodr JAYcodr commented May 23, 2026

Summary

  • 翻译 legal/ 目录(2 文件)和根目录首页(2 文件),完成整个 GitBook 中文文档覆盖:
    • legal/privacy-policy.zh-CN.md — 隐私政策(GDPR/DPDP/CCPA/LGPD/PIPEDA 合规说明)
    • legal/terms-of-use.zh-CN.md — 使用条款(服务、责任、AI 输出免责声明、终止)
    • README.zh-CN.md — 项目首页欢迎与核心功能介绍
    • SUMMARY.zh-CN.md — 目录导航,全部链接本地化至已存在的 .zh-CN.md 版本
  • 修复英文 README.md 中的坏链:features/mascot.mdfeatures/mascot/README.md

This is Batch E of the ongoing i18n documentation effort, completing the Chinese documentation set for the entire gitbooks/ tree.

Problem

legal/ 目录和根目录 README.md/SUMMARY.md 是 GitBook 中最后一批未翻译的内容。中文用户阅读到法律条款和项目首页时仍只能看到英文,影响完整体验。左侧导航栏因 SUMMARY 未翻译,部分条目仍为英文。

Solution

逐句翻译,保持法律文本的正式语气与产品介绍的活泼语气:

  • privacy-policy.zh-CN.md / terms-of-use.zh-CN.md:保留所有法律专有名词(GDPR、CCPA/CPRA、LGPD、PIPEDA 等),翻译解释性文字
  • README.zh-CN.md:保留产品名、技术模块名(Memory Tree、TokenJuice、Agent Harness 等),翻译功能描述
  • SUMMARY.zh-CN.md:所有已存在 .zh-CN.md 的链接全部本地化,未翻译的页面保留英文原链

术语遵循 .kimi/terminology-zh-CN.md:OAuth、API key、token、SQLite、Markdown、Obsidian 等保留英文;通用概念中文化。

Submission Checklist

  • Tests added or updated — N/A: docs-only translation, no code changes
  • Diff coverage ≥ 80%N/A: docs-only, no executable code changed
  • Coverage matrix updated — N/A: docs-only change
  • All affected feature IDs from the matrix are listed — N/A: docs-only change
  • No new external network dependencies introduced — N/A: docs-only change
  • Manual smoke checklist updated — N/A: docs-only change
  • Linked issue closed — N/A: standalone docs batch, no linked issue

Impact

  • 仅影响 GitBook 文档渲染,无运行时/平台影响
  • 无性能、安全、迁移或兼容性影响
  • legal/ 目录翻译完成度从 0% 提升至 100%
  • 根目录首页与导航完成度从 0% 提升至 100%
  • GitBook 左侧导航全部中文,中文读者体验质变

Related


AI Authored PR Metadata

Linear Issue

  • Key: N/A
  • URL: N/A

Commit & Branch

  • Branch: docs/i18n-batch-e-legal-and-home
  • Commit SHA: 4a4ff075

Validation Run

  • pnpm --filter openhuman-app format:checkN/A: no app code changes
  • pnpm typecheckN/A: no app code changes
  • Focused tests — N/A: no code changes
  • Rust fmt/check — N/A: no Rust code changes
  • Tauri fmt/check — N/A: no Tauri code changes

Validation Blocked

  • command:N/A
  • error:N/A
  • impact:N/A

Behavior Changes

  • Intended behavior change: 新增 4 个中文文档页面,修复 1 个英文坏链
  • User-visible effect: GitBook 中文读者可阅读完整的中文文档集,包括法律条款、项目首页和目录导航

Parity Contract

  • Legacy behavior preserved: 英文原文完整保留,仅新增 .zh-CN.md 文件
  • Guard/fallback/dispatch parity checks: N/A

Duplicate / Superseded PR Handling

  • Duplicate PR(s): None
  • Canonical PR: This one
  • Resolution: N/A

Summary by CodeRabbit

  • Documentation
    • Reorganized documentation link structure
    • Added comprehensive Chinese-language documentation suite including product introduction, complete navigation guide, privacy policy, and terms of use to support Chinese-speaking users

Review Change Stack

@JAYcodr JAYcodr requested a review from a team May 23, 2026 08:44
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 23, 2026

📝 Walkthrough

Walkthrough

This PR adds comprehensive Chinese-language documentation to the OpenHuman GitBook, including a new README, navigation table of contents, privacy policy, and terms of use. Additionally, it corrects the English README's mascot documentation link to reflect a relocated file structure.

Changes

Chinese GitBook Documentation

Layer / File(s) Summary
English README link fix and Chinese README introduction
gitbooks/README.md, gitbooks/README.zh-CN.md
Updated the mascot documentation link from features/mascot.md to features/mascot/README.md in the English README. Added a new Chinese README introducing OpenHuman as a desktop AI assistant with Rust+Tauri architecture, covering memory trees, Obsidian-style output, 118+ OAuth integrations, token compression, model routing, and native tooling.
Chinese GitBook navigation structure
gitbooks/SUMMARY.zh-CN.md
Created a complete Chinese-language table of contents organizing sections for overview (概述), features (功能), development (开发), and legal (法律) with navigation links to all corresponding documentation pages.
Chinese legal documentation
gitbooks/legal/privacy-policy.zh-CN.md, gitbooks/legal/terms-of-use.zh-CN.md
Added privacy policy documenting information collection, usage, retention, deletion, security measures, user rights, and contact information (privacy@tinyhumans.ai). Added terms of use defining service scope, user responsibilities, content ownership, AI output disclaimers, liability limits, termination conditions, and system permission consent statements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • tinyhumansai/openhuman#2005: Prior documentation-only update adding Japanese language selector and linking to GitBook/README internationalization.

Suggested labels

working

Suggested reviewers

  • senamakel
  • graycyrus

Poem

🐰 A GitBook grows with words so clear,
Chinese whispers now appear,
Privacy and terms aligned,
With mascot links refined—
Documentation blooms this year! 📚✨

🚥 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 identifies the main change: adding Chinese translations for legal documents, README, and summary files, which accurately represents the bulk of changes in the PR.
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.

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


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.

@coderabbitai coderabbitai Bot added the working A PR that is being worked on by the team. label May 23, 2026
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 current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@gitbooks/legal/terms-of-use.zh-CN.md`:
- Line 56: The Chinese Terms of Use still contains the placeholder "[插入司法管辖区]";
replace that placeholder in terms-of-use.zh-CN.md with the actual governing
jurisdiction name chosen for this product (e.g., the appropriate country/region
string used in the English terms), ensure the Chinese phrasing matches the legal
text used in the canonical Terms of Use source, and search the repo for any
other occurrences of "[插入司法管辖区]" to update them consistently before merging.
🪄 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: 23b92aff-15c0-4b89-ad5a-ee4575975fa8

📥 Commits

Reviewing files that changed from the base of the PR and between fe37b13 and 4a4ff07.

📒 Files selected for processing (5)
  • gitbooks/README.md
  • gitbooks/README.zh-CN.md
  • gitbooks/SUMMARY.zh-CN.md
  • gitbooks/legal/privacy-policy.zh-CN.md
  • gitbooks/legal/terms-of-use.zh-CN.md


## 适用法律

这些条款受 [插入司法管辖区] 的法律管辖,不考虑法律冲突原则。
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 | ⚡ Quick win

Replace governing-law placeholder before merge.

Line 56 still has [插入司法管辖区], which leaves the legal term incomplete and ambiguous for users.

Suggested fix
-这些条款受 [插入司法管辖区] 的法律管辖,不考虑法律冲突原则。
+这些条款受 [实际司法管辖区名称] 的法律管辖,不考虑法律冲突原则。

As per coding guidelines: “New or changed user-visible behavior must ship with matching documentation.”

🤖 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/legal/terms-of-use.zh-CN.md` at line 56, The Chinese Terms of Use
still contains the placeholder "[插入司法管辖区]"; replace that placeholder in
terms-of-use.zh-CN.md with the actual governing jurisdiction name chosen for
this product (e.g., the appropriate country/region string used in the English
terms), ensure the Chinese phrasing matches the legal text used in the canonical
Terms of Use source, and search the repo for any other occurrences of
"[插入司法管辖区]" to update them consistently before merging.

@JAYcodr
Copy link
Copy Markdown
Contributor Author

JAYcodr commented May 23, 2026

Reply to CodeRabbit

The [Insert Jurisdiction] placeholder exists in the English source (terms-of-use.md:56) and was translated faithfully into Chinese. Replacing it with an actual jurisdiction requires a product/legal decision that should apply to both the English and Chinese versions simultaneously. Suggest handling that in a separate PR rather than this i18n translation batch.

@JAYcodr
Copy link
Copy Markdown
Contributor Author

JAYcodr commented May 23, 2026

Reply to CI failures

CI failures (sccache-action Bad credentials + Windows test executable not found) are unrelated to this docs-only change. These appear to be upstream CI infrastructure issues.

@JAYcodr
Copy link
Copy Markdown
Contributor Author

JAYcodr commented May 23, 2026

@senamakel Could you take a look at the CodeRabbit comments above when you have a sec? The jurisdiction placeholder is inherited from the English source, and the CI failures look like infra noise rather than something from this PR. Don't want to scope-creep this translation batch if these need separate handling 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

working A PR that is being worked on by the team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant