nofx/docs/i18n/README.md

# 🌍 International Documentation / 国际化文档

NOFX documentation is available in multiple languages.

NOFX 文档提供多种语言版本。

---

## 📚 Available Languages / 可用语言

| Language | Main README | Status | Maintainers |
|----------|-------------|--------|-------------|
| 🇬🇧 **English** | [README.md](../../README.md) | ✅ Complete | Core Team |
| 🇨🇳 **Chinese (中文)** | [README.md](zh-CN/README.md) | ✅ Complete | Community |
| 🇷🇺 **Russian (Русский)** | [README.md](ru/README.md) | ✅ Complete | Community |
| 🇺🇦 **Ukrainian (Українська)** | [README.md](uk/README.md) | ✅ Complete | Community |

---

## 🔗 Quick Access / 快速访问

### English 🇬🇧
- **Main README:** [../../README.md](../../README.md)
- **Contributing:** [../../CONTRIBUTING.md](../../CONTRIBUTING.md)
- **Security:** [../../SECURITY.md](../../SECURITY.md)

### 中文 🇨🇳
- **主 README:** [zh-CN/README.md](zh-CN/README.md)
- **贡献指南:** [../../CONTRIBUTING.md](../../CONTRIBUTING.md#中文)
- **安全政策:** [../../SECURITY.md](../../SECURITY.md#中文)
- **常见问题:** [../guides/faq.zh-CN.md](../guides/faq.zh-CN.md)

### Русский 🇷🇺
- **Основной README:** [ru/README.md](ru/README.md)
- **Руководство по участию:** [../../CONTRIBUTING.md](../../CONTRIBUTING.md)
- **Политика безопасности:** [../../SECURITY.md](../../SECURITY.md)

### Українська 🇺🇦
- **Головний README:** [uk/README.md](uk/README.md)
- **Посібник із внесків:** [../../CONTRIBUTING.md](../../CONTRIBUTING.md)
- **Політика безпеки:** [../../SECURITY.md](../../SECURITY.md)

---

## 🤝 Help with Translations / 帮助翻译

### Want to Contribute Translations? / 想要贡献翻译？

We welcome translation contributions! / 我们欢迎翻译贡献！

**What needs translation? / 需要翻译什么？**
- ✅ Main README (complete for 4 languages)
- 🚧 Deployment guides (partial)
- 📋 User guides (needed)
- 📋 Contributing guide (needed for RU/UK)

**How to contribute translations? / 如何贡献翻译？**

1. **Check existing translations / 检查现有翻译**
   - Browse this directory
   - See what's missing

2. **Claim a translation task / 认领翻译任务**
   - Open a GitHub Issue
   - Title: `[TRANSLATION] Document name to Language`
   - Example: `[TRANSLATION] CONTRIBUTING.md to Chinese`

3. **Submit translation / 提交翻译**
   - Follow [Contributing Guide](../../CONTRIBUTING.md)
   - Place file in appropriate language folder
   - Keep formatting and structure consistent

4. **Get recognized / 获得认可**
   - Listed as translator in credits
   - Eligible for contributor badges
   - Possible bounty rewards ($50-200)

---

## 📝 Translation Guidelines / 翻译指南

### File Naming Convention / 文件命名规范

**Pattern:** `document-name.{language-code}.md`

**Examples:**
```
README.md                    → en (default)
docker-deploy.zh-CN.md       → Chinese
docker-deploy.ru.md          → Russian
faq.zh-CN.md                 → Chinese FAQ
```

**Language Codes:**
- `en` - English (default, no suffix needed)
- `zh-CN` - Simplified Chinese
- `ru` - Russian
- `uk` - Ukrainian
- `ja` - Japanese *(future)*
- `ko` - Korean *(future)*

### Quality Standards / 质量标准

**Must have / 必须具备:**
- ✅ Accurate technical terms
- ✅ Natural, fluent language
- ✅ Consistent terminology
- ✅ Preserved formatting (markdown)
- ✅ Working internal links

**Avoid / 避免:**
- ❌ Machine translation without review
- ❌ Inconsistent terminology
- ❌ Broken links or formatting
- ❌ Cultural insensitivity

### Technical Terms / 技术术语

**Keep in English (don't translate):**
- API, HTTP, REST, JSON
- Docker, Kubernetes
- GitHub, Git, Pull Request
- Specific tool names (Binance, Hyperliquid)

**Example - Chinese:**
- ✅ "启动 Docker 容器" (start Docker container)
- ❌ "启动 多克 容器" (transliterated Docker)

---

## 🌐 Request a New Language / 请求新语言

### Want NOFX in your language? / 希望 NOFX 支持你的语言？

**Steps / 步骤:**

1. **Check if it's planned / 检查是否已计划**
   - See list below
   - Search GitHub Issues

2. **Create a request / 创建请求**
   - Open GitHub Issue
   - Title: `[TRANSLATION REQUEST] Language name`
   - Explain: Number of potential users, your willingness to help

3. **Volunteer to help / 志愿帮助**
   - Offer to translate
   - Find other speakers to review
   - Commit to maintaining updates

### Planned Languages / 计划中的语言

| Language | Status | Need Volunteers? |
|----------|--------|------------------|
| 🇯🇵 Japanese | 📋 Planned | ✅ Yes |
| 🇰🇷 Korean | 📋 Planned | ✅ Yes |
| 🇪🇸 Spanish | 📋 Planned | ✅ Yes |
| 🇫🇷 French | 📋 Planned | ✅ Yes |
| 🇩🇪 German | 📋 Planned | ✅ Yes |

---

## 👥 Translation Team / 翻译团队

### Current Translators / 当前翻译者

| Language | Translators | Status |
|----------|-------------|--------|
| 🇨🇳 Chinese | Community | Active |
| 🇷🇺 Russian | Community | Active |
| 🇺🇦 Ukrainian | Community | Active |

**Want to join the team? / 想加入团队？**
- Contact on [Telegram](https://t.me/nofx_dev_community)
- Open an issue on GitHub
- DM [@nofx_ai](https://x.com/nofx_ai) on Twitter

---

## 📊 Translation Progress / 翻译进度

### Document Coverage / 文档覆盖率

| Document | EN | 中文 | РУ | УК |
|----------|----|----|----|----|
| Main README | ✅ | ✅ | ✅ | ✅ |
| CONTRIBUTING | ✅ | ✅ | 🚧 | 🚧 |
| CODE_OF_CONDUCT | ✅ | ✅ | 🚧 | 🚧 |
| SECURITY | ✅ | ✅ | 🚧 | 🚧 |
| Docker Deploy | ✅ | ✅ | ❌ | ❌ |
| FAQ | ✅ | ✅ | ❌ | ❌ |

**Legend / 图例:**
- ✅ Complete / 完成
- 🚧 In Progress / 进行中
- ❌ Not Started / 未开始

---

## 🎯 Priority Translations / 优先翻译

**High Priority / 高优先级:**
1. CONTRIBUTING.md (all languages)
2. Docker deployment guides
3. FAQ sections

**Medium Priority / 中优先级:**
1. User guides
2. Troubleshooting docs
3. API reference

**Low Priority / 低优先级:**
1. Architecture docs (technical, less urgent)
2. Advanced configuration guides

---

## 🆘 Translation Help / 翻译帮助

**Questions? / 有问题？**
- 💬 Ask in [Telegram Community](https://t.me/nofx_dev_community)
- 🐙 Open a [GitHub Issue](https://github.com/tinkle-community/nofx/issues)
- 📧 Contact maintainers

**Resources / 资源:**
- [Contributing Guide](../../CONTRIBUTING.md) - How to submit
- [Markdown Guide](https://www.markdownguide.org/) - Formatting reference

---

[← Back to Documentation Home](../README.md)