Documentation Internationalization
中文：文档国际化规则
Language Layout
| Document type | Required language model |
|---|---|
| Top-level project docs | English *.md plus Chinese companion. The root README uses README_CN.md; other root governance docs use *.zh-CN.md. |
| Core authored docs | English pages live under docs/en/**; Chinese pages live under docs/zh/** with the same relative paths. |
| Language indexes | docs/README.md selects a language. docs/en/README.md and docs/zh/README.md are language-specific documentation homes. |
| Subdirectory README docs | Use README.md or README.en.md for English and README.zh-CN.md for Chinese when the directory is developer-facing. |
| Generated reports | Generated source file plus a companion summary in the other language. |
Maintenance Rules
- Add or update both language files in the same pull request for every core documentation page.
- Keep commands, paths, API names, and code snippets identical unless the target language requires explanatory text.
- Do not translate protocol identifiers such as
.umodel,.entity,.topo,GraphStore,EntitySet,DataLink, andStorageLink. - Generated reports may keep their generated source language, but must include a companion page with scope, regeneration command, and current status in the other language.
- Keep English links inside
docs/en/**and Chinese links insidedocs/zh/**unless the link intentionally crosses to the other language.
Coverage
The repository now includes language pairs for:
- Root governance docs: README, CONTRIBUTING, SECURITY, SUPPORT, CODE_OF_CONDUCT, CHANGELOG.
- Core docs tree: getting started, concepts, guides, architecture, reference, UI, SDK specification. These pages exist as separate English and Chinese files.
- Runtime and module docs: API, commands, internal modules, public packages, schemas, deployments, examples, tests, tools, SDKs, Web UI, generated Java docs.
- Generated reports: example validation and expanded schema reports have English companion summaries.