- Create README.md for internationalization (i18n) documentation - Add English translation for main README and quick start guide - Add Japanese translation for main README - Add Simplified Chinese translation for main README - Introduce sample Docker Compose configurations for various deployment scenarios - Implement CI/CD documentation for testing and deployment workflows - Establish end-to-end testing guidelines and strategies - Create test strategy documentation outlining unit, integration, and E2E tests |
||
|---|---|---|
| .. | ||
| getting-started | ||
| README.md | ||
ConvertX-CN Documentation
🌐 Translation Info
- Original: 繁體中文版
- Translation Version: v0.1.0
- Last Updated: 2026-01-23
- Status: 🚧 In Progress
Welcome to ConvertX-CN Documentation! Choose your role to find the information you need.
🚀 Quick Start
New to ConvertX-CN? Start here:
- Overview — What is ConvertX-CN
- Quick Start — Deploy in 5 minutes
- FAQ — Common questions
👤 User Guide
For general users:
| Document | Description |
|---|---|
| Quick Start | Fastest deployment method |
| Supported Converters | All available formats |
| OCR | Optical Character Recognition |
| Translation | PDF translation (preserves formulas) |
| Languages | Interface language settings |
| FAQ | Frequently Asked Questions |
🛠️ Administrator Guide
For deployment and maintenance:
Deployment
| Document | Description |
|---|---|
| Docker Deployment | Docker Run & Docker Compose |
| Reverse Proxy | Nginx / Traefik / Caddy |
| Sample Configs | Ready-to-use configurations |
Configuration
| Document | Description |
|---|---|
| Environment Variables | All available settings |
| Security | HTTPS, authentication, protection |
| Cleanup & Limits | Auto cleanup, resource limits |
👩💻 Developer Guide
For contributors and extension development:
Development
| Document | Description |
|---|---|
| Project Structure | Code structure |
| Local Development | Dev environment setup |
| Contribution Guide | How to contribute |
API
| Document | Description |
|---|---|
| API Overview | REST & GraphQL API |
| API Endpoints | Endpoint details |
🔗 Quick Links
- 📦 GitHub Repo
- 🐛 Issues
- 💬 Discussions
💡 Can't find what you need? Ask in GitHub Discussions!