文档国际化规则
English: Documentation Internationalization
UModel 文档以英文和中文共同维护。
语言目录
| 文档类型 | 语言要求 |
|---|---|
| 顶层项目文档 | 英文 *.md 加中文 companion。根 README 使用 README_CN.md;其他根治理文档使用 *.zh-CN.md。 |
| 核心手写文档 | 英文页面位于 docs/en/**;中文页面位于 docs/zh/**,两套目录保持相同相对路径。 |
| 语言索引 | docs/README.md 选择语言。docs/en/README.md 与 docs/zh/README.md 是对应语言的文档首页。 |
| 子目录 README | 面向开发者的目录使用 README.md 或 README.en.md 承载英文,使用 README.zh-CN.md 承载中文。 |
| 生成报告 | 保留生成源文件,并提供另一语言的 companion summary。 |
维护规则
- 核心文档页在同一个 PR 中同时更新英文文件和中文文件。
- 命令、API 路径、协议标识符和代码片段应在两种语言中保持等价。
- 不翻译
.umodel、.entity、.topo、GraphStore、EntitySet、DataLink、StorageLink等协议或模型标识符。 - 生成报告可保留生成源语言,但必须有另一语言的 companion summary,包含范围、再生成命令和当前状态。
- 英文文档内部链接应优先留在
docs/en/**,中文文档内部链接应优先留在docs/zh/**;只有语言切换链接才跨语言。
覆盖范围
当前仓库包含以下语言配对:
- 顶层治理文档:README、CONTRIBUTING、SECURITY、SUPPORT、CODE_OF_CONDUCT、CHANGELOG。
- 核心文档树:getting started、concepts、guides、architecture、reference、UI、SDK specification。这些页面以独立英文和中文文件维护。
- 运行时与模块文档:API、commands、internal modules、public packages、schemas、deployments、examples、tests、tools、SDKs、Web UI、generated Java docs。
- 生成报告:example validation 与 expanded schema reports 均有英文 companion summary。