Documentation Internationalization (i18n)¶
HiveFlow uses mkdocs-static-i18n with a folder layout:
docs/
├── assets/ # shared (language-agnostic)
├── en/ # English (default)
└── zh/ # 简体中文
Rules for contributors¶
| Keep in English | Translate to Chinese (in docs/zh/) |
|---|---|
| Code blocks, CLI commands | Headings, paragraphs, tables |
API names (HiveFlow, ECM) |
Navigation labels (in mkdocs.yml) |
Env vars (HIVEFLOW_*) |
Admonition titles |
| File paths, PyPI names | Case study narrative |
When you add a new page:
- Create
docs/en/your-page.md - Create
docs/zh/your-page.md - Add both entries to the
enandzhnavsections inmkdocs.yml
Verify¶
python -m mkdocs build --strict
The site builds site/en/ and site/zh/ with a language switcher in the Material theme.
Repository READMEs¶
| File | Language |
|---|---|
| README.md | English |
| README.zh.md | 简体中文 |
| packages/core/README.md | English |
| packages/core/README.zh.md | 简体中文 |
(same for agent/, studio/) |