Add comprehensive documentation for ConvertX-CN deployment and configuration
- Create 指定版本部署.md to explain fixed version deployment - Create 最新版.md detailing the use of the latest tag - Create 版本選擇指南.md to guide users on version selection - Add Nginx and Traefik configuration examples for reverse proxy - Introduce minimal and production configuration examples - Develop Docker deployment guide with detailed steps - Implement quick start guide for first-time Docker users - Include version update instructions and rollback procedures - Add troubleshooting section for common issues - Enhance overall documentation structure and links for better navigation
This commit is contained in:
Your Name
parent
c2d3d13c89
commit
3f1a5e0fbf
51 changed files with 544 additions and 579 deletions
172
docs/說明文件.md
Normal file
172
docs/說明文件.md
Normal file
|
|
@ -0,0 +1,172 @@
|
|||
# ConvertX-CN 文件中心
|
||||
|
||||
歡迎來到 ConvertX-CN 文件！選擇您的角色快速找到所需資訊。
|
||||
|
||||
---
|
||||
|
||||
## 🚀 快速入門
|
||||
|
||||
剛開始使用？從這裡開始：
|
||||
|
||||
1. **[概覽](快速入門/概覽.md)** — 了解 ConvertX-CN 是什麼
|
||||
2. **[快速開始](快速入門/快速開始.md)** — 5 分鐘內完成部署
|
||||
3. **[常見問題](快速入門/常見問題.md)** — 解決常見問題
|
||||
|
||||
---
|
||||
|
||||
## 👤 使用者指南
|
||||
|
||||
適合一般使用者：
|
||||
|
||||
| 文件 | 說明 |
|
||||
| ------------------------------------ | -------------------- |
|
||||
| [快速開始](快速入門/快速開始.md) | 最快部署方式 |
|
||||
| [支援的轉換器](功能說明/轉換器.md) | 所有可用的轉換格式 |
|
||||
| [OCR 功能](功能說明/OCR.md) | 光學字元辨識 |
|
||||
| [翻譯功能](功能說明/翻譯功能.md) | PDF 翻譯（保留公式） |
|
||||
| [多語言介面](功能說明/多語言介面.md) | 切換介面語言 |
|
||||
| [常見問題](快速入門/常見問題.md) | FAQ |
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ 系統管理員指南
|
||||
|
||||
適合部署與維護人員：
|
||||
|
||||
### 部署
|
||||
|
||||
| 文件 | 說明 |
|
||||
| ------------------------------------- | --------------------------- |
|
||||
| [Docker 部署](部署指南/Docker部署.md) | Docker Run & Docker Compose |
|
||||
| [反向代理](部署指南/反向代理.md) | Nginx / Traefik / Caddy |
|
||||
| [範例配置](範例配置/說明文件.md) | 可直接使用的配置檔 |
|
||||
|
||||
### 配置
|
||||
|
||||
| 文件 | 說明 |
|
||||
| ------------------------------------ | ------------------ |
|
||||
| [環境變數](配置設定/環境變數.md) | 所有可用設定 |
|
||||
| [安全性設定](配置設定/安全性.md) | HTTPS、認證、防護 |
|
||||
| [清理與限制](配置設定/清理與限制.md) | 自動清理、資源限制 |
|
||||
|
||||
---
|
||||
|
||||
## 👩💻 開發者指南
|
||||
|
||||
適合貢獻者與擴充開發：
|
||||
|
||||
### 開發
|
||||
|
||||
| 文件 | 說明 |
|
||||
| -------------------------------- | -------------- |
|
||||
| [專案結構](開發指南/專案結構.md) | 程式碼結構說明 |
|
||||
| [本地開發](開發指南/本地開發.md) | 開發環境設定 |
|
||||
| [貢獻指南](開發指南/貢獻指南.md) | 如何參與專案 |
|
||||
|
||||
### API
|
||||
|
||||
| 文件 | 說明 |
|
||||
| ----------------------- | ------------------ |
|
||||
| [API 總覽](API/總覽.md) | REST & GraphQL API |
|
||||
| [API 端點](API/端點.md) | 詳細端點說明 |
|
||||
|
||||
### 測試
|
||||
|
||||
| 文件 | 說明 |
|
||||
| ---------------------------- | -------------- |
|
||||
| [測試策略](測試/測試策略.md) | 測試類型與方法 |
|
||||
| [CI/CD](測試/CI-CD.md) | 持續整合設定 |
|
||||
| [E2E 測試](測試/E2E測試.md) | 端對端測試 |
|
||||
|
||||
---
|
||||
|
||||
## 📁 文件結構
|
||||
|
||||
```
|
||||
docs/
|
||||
├── 說明文件.md ← 您在這裡
|
||||
├── 快速入門/
|
||||
│ ├── 概覽.md
|
||||
│ ├── 快速開始.md
|
||||
│ └── 常見問題.md
|
||||
├── 部署指南/
|
||||
│ ├── Docker部署.md
|
||||
│ └── 反向代理.md
|
||||
├── 配置設定/
|
||||
│ ├── 環境變數.md
|
||||
│ ├── 安全性.md
|
||||
│ └── 清理與限制.md
|
||||
├── 功能說明/
|
||||
│ ├── 轉換器.md
|
||||
│ ├── 翻譯功能.md
|
||||
│ ├── OCR.md
|
||||
│ └── 多語言介面.md
|
||||
├── API/
|
||||
│ ├── 總覽.md
|
||||
│ └── 端點.md
|
||||
├── 測試/
|
||||
│ ├── 測試策略.md
|
||||
│ ├── CI-CD.md
|
||||
│ └── E2E測試.md
|
||||
├── 開發指南/
|
||||
│ ├── 專案結構.md
|
||||
│ ├── 本地開發.md
|
||||
│ └── 貢獻指南.md
|
||||
└── 範例配置/
|
||||
├── 最小配置.yml
|
||||
├── 生產環境配置.yml
|
||||
├── Traefik配置.yml
|
||||
└── Nginx範例配置.conf
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔗 快速連結
|
||||
|
||||
- 📦 [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)
|
||||
- 📝 [Changelog](../CHANGELOG.md)
|
||||
- 📄 [License](../LICENSE)
|
||||
|
||||
---
|
||||
|
||||
## 📖 閱讀路徑建議
|
||||
|
||||
### 我是新手
|
||||
|
||||
1. [概覽](快速入門/概覽.md)
|
||||
2. [快速開始](快速入門/快速開始.md)
|
||||
3. [支援的轉換器](功能說明/轉換器.md)
|
||||
|
||||
### 我要部署到生產環境
|
||||
|
||||
1. [Docker 部署](部署指南/Docker部署.md)
|
||||
2. [反向代理](部署指南/反向代理.md)
|
||||
3. [安全性設定](配置設定/安全性.md)
|
||||
4. [環境變數](配置設定/環境變數.md)
|
||||
|
||||
### 我想參與開發
|
||||
|
||||
1. [專案結構](開發指南/專案結構.md)
|
||||
2. [本地開發](開發指南/本地開發.md)
|
||||
3. [貢獻指南](開發指南/貢獻指南.md)
|
||||
4. [測試策略](測試/測試策略.md)
|
||||
|
||||
---
|
||||
|
||||
## 🌐 多語言文件
|
||||
|
||||
此文件以繁體中文為主，我們也提供其他語言版本：
|
||||
|
||||
| 語言 | 說明 | 狀態 |
|
||||
| -------------------------------- | --------------------- | --------- |
|
||||
| [English](多語言/en/Overview.md) | English documentation | 🔄 進行中 |
|
||||
| [简体中文](多語言/zh-CN/概述.md) | 简体中文文档 | 📋 規劃中 |
|
||||
| [日本語](多語言/ja/概要.md) | 日本語ドキュメント | 📋 規劃中 |
|
||||
|
||||
> 📝 **想幫忙翻譯？** 請參閱 [翻譯指南](多語言/翻譯指南.md)
|
||||
|
||||
---
|
||||
|
||||
> 💡 **找不到您需要的資訊？** 歡迎到 [GitHub Discussions](https://github.com/pi-docket/ConvertX-CN/discussions) 發問！
|
||||
Loading…
Add table
Add a link
Reference in a new issue