Translations
Unne documentation is available in the following languages. Help us translate!
Available Languages
| Language | Link | Status | Maintainer |
|---|---|---|---|
| English | Docs | Complete | Core Team |
| Русский | Документация | Complete | Core Team |
| O'zbek | Hujjatlar | Complete | Community |
| Қазақша | Құжаттама | Complete | Community |
| Français | Documentation | Complete | Community |
| العربية | التوثيق | Complete | Community |
| 中文 | 文档 | Complete | Community |
Help Us Translate
We welcome contributions to improve existing translations or add new languages.
How to Contribute
- Fork the unne-cli/core repository
- Find the page you want to improve in
docs/<lang>/ - Edit the translation — use the English version (
docs/) as reference - Submit a Pull Request
Translation Guidelines
- Keep code blocks, commands, and technical terms (
unne,unns,yaml,yamux) unchanged - Keep the same Markdown structure — headings, tables, lists
- Translate UI text, descriptions, and explanations naturally
- For RTL languages (Arabic), the
dir: rtlis already configured in VitePress - Use the native script for each language (Cyrillic for Russian/Kazakh, Latin for Uzbek/French, etc.)
Adding a New Language
Want to add a language we don't support yet?
- Create a new directory:
docs/<lang-code>/ - Copy all English pages into it
- Translate the pages
- Add locale config in
docs/.vitepress/config.ts:
ts
// In the locales section:
xx: {
label: 'Your Language',
lang: 'xx',
themeConfig: {
nav: [...],
sidebar: {...},
}
}- Submit a PR — we'll review and merge!
Translation Priorities
If you're looking for where to start, prioritize these pages:
guide/getting-started.md— most visited pageguide/what-is-unne.md— introductioncli/overview.md— CLI referenceserver/installation.md— server setupcli/configuration.md— config reference
Quality Standards
- Translations should read naturally — not word-for-word machine translation
- Technical accuracy is more important than literary style
- When in doubt, keep the English term with a brief explanation in parentheses
- Test your changes locally:
cd docs && bun run dev
Contact
- Open an issue for translation questions
- Tag your PR with
translationlabel