da856d89ff
- 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
95 lines
3.5 KiB
Markdown
95 lines
3.5 KiB
Markdown
# ConvertX-CN Documentation
|
|
|
|
> 🌐 **Language / 語言**
|
|
> [繁體中文](../../README.md) | **English** | [简体中文](../zh-CN/README.md)
|
|
|
|
> 🌐 **Translation Info**
|
|
>
|
|
> - Original: [繁體中文版](../../README.md)
|
|
> - 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:
|
|
|
|
1. **[Overview](getting-started/overview.md)** — What is ConvertX-CN
|
|
2. **[Quick Start](getting-started/quick-start.md)** — Deploy in 5 minutes
|
|
3. **[FAQ](getting-started/faq.md)** — Common questions
|
|
|
|
---
|
|
|
|
## 👤 User Guide
|
|
|
|
For general users:
|
|
|
|
| Document | Description |
|
|
| ---------------------------------------------- | ------------------------------------ |
|
|
| [Quick Start](getting-started/quick-start.md) | Fastest deployment method |
|
|
| [Supported Converters](features/converters.md) | All available formats |
|
|
| [OCR](features/ocr.md) | Optical Character Recognition |
|
|
| [Translation](features/translation.md) | PDF translation (preserves formulas) |
|
|
| [Languages](features/i18n.md) | Interface language settings |
|
|
| [FAQ](getting-started/faq.md) | Frequently Asked Questions |
|
|
|
|
---
|
|
|
|
## 🛠️ Administrator Guide
|
|
|
|
For deployment and maintenance:
|
|
|
|
### Deployment
|
|
|
|
| Document | Description |
|
|
| -------------------------------------------- | --------------------------- |
|
|
| [Docker Deployment](deployment/docker.md) | Docker Run & Docker Compose |
|
|
| [Reverse Proxy](deployment/reverse-proxy.md) | Nginx / Traefik / Caddy |
|
|
| [Sample Configs](samples/README.md) | Ready-to-use configurations |
|
|
|
|
### Configuration
|
|
|
|
| Document | Description |
|
|
| --------------------------------------------------------------- | --------------------------------- |
|
|
| [Environment Variables](configuration/environment-variables.md) | All available settings |
|
|
| [Security](configuration/security.md) | HTTPS, authentication, protection |
|
|
| [Cleanup & Limits](configuration/limits-and-cleanup.md) | Auto cleanup, resource limits |
|
|
|
|
---
|
|
|
|
## 👩💻 Developer Guide
|
|
|
|
For contributors and extension development:
|
|
|
|
### Development
|
|
|
|
| Document | Description |
|
|
| ----------------------------------------------------- | --------------------- |
|
|
| [Project Structure](development/project-structure.md) | Code structure |
|
|
| [Local Development](development/local-development.md) | Dev environment setup |
|
|
| [Contribution Guide](development/contribution.md) | How to contribute |
|
|
|
|
### API
|
|
|
|
| Document | Description |
|
|
| --------------------------------- | ------------------ |
|
|
| [API Overview](api/overview.md) | REST & GraphQL API |
|
|
| [API Endpoints](api/endpoints.md) | Endpoint details |
|
|
|
|
---
|
|
|
|
## 🔗 Quick Links
|
|
|
|
- 📦 [GitHub Repo](https://github.com/pi-docket/ConvertX-CN)
|
|
- 🐛 [Issues](https://github.com/pi-docket/ConvertX-CN/issues)
|
|
- 💬 [Discussions](https://github.com/pi-docket/ConvertX-CN/discussions)
|
|
|
|
---
|
|
|
|
> 💡 **Can't find what you need?** Ask in [GitHub Discussions](https://github.com/pi-docket/ConvertX-CN/discussions)!
|