Refactor documentation for improved clarity and consistency
- Updated tables for service ports, environment variables, HTTP status codes, and error codes to enhance readability. - Streamlined JavaScript examples for file conversion and added comments for better understanding. - Enhanced troubleshooting section with clearer formatting and additional explanations. - Improved licensing section with detailed requirements and third-party component licenses. - Organized the document structure for better navigation and accessibility.
This commit is contained in:
parent
caecb2e001
commit
394dcbec1a
11 changed files with 538 additions and 497 deletions
30
README.md
30
README.md
|
|
@ -28,17 +28,17 @@
|
|||
|
||||
完整文件請參閱 **[專案總覽](docs/00-專案總覽.md)**
|
||||
|
||||
| 章節 | 說明 | 連結 |
|
||||
| ---- | ---- | ---- |
|
||||
| 📖 **00 專案總覽** | 專案定位、功能特色、版本比較 | [查看](docs/00-專案總覽.md) |
|
||||
| 🚀 **01 快速開始** | 5 分鐘部署完成 | [查看](docs/01-快速開始.md) |
|
||||
| 🐳 **02 部署指南** | Docker 設定、反向代理、HTTPS | [查看](docs/02-部署指南.md) |
|
||||
| ⚙️ **03 環境變數** | 所有可用設定與推薦值 | [查看](docs/03-環境變數與設定.md) |
|
||||
| 🔌 **04 功能總覽** | 轉換器、OCR、PDF 翻譯 | [查看](docs/04-功能總覽.md) |
|
||||
| 🔗 **05 API 文件** | REST & GraphQL API | [查看](docs/05-API文件.md) |
|
||||
| 🔧 **06 錯誤排查** | 常見問題與解決方案 | [查看](docs/06-錯誤排查與支援.md) |
|
||||
| 👩💻 **07 開發指南** | 專案結構、貢獻規範 | [查看](docs/07-開發與貢獻指南.md) |
|
||||
| 📄 **08 授權說明** | AGPL-3.0 授權 | [查看](docs/08-授權說明.md) |
|
||||
| 章節 | 說明 | 連結 |
|
||||
| ------------------ | ---------------------------- | --------------------------------- |
|
||||
| 📖 **00 專案總覽** | 專案定位、功能特色、版本比較 | [查看](docs/00-專案總覽.md) |
|
||||
| 🚀 **01 快速開始** | 5 分鐘部署完成 | [查看](docs/01-快速開始.md) |
|
||||
| 🐳 **02 部署指南** | Docker 設定、反向代理、HTTPS | [查看](docs/02-部署指南.md) |
|
||||
| ⚙️ **03 環境變數** | 所有可用設定與推薦值 | [查看](docs/03-環境變數與設定.md) |
|
||||
| 🔌 **04 功能總覽** | 轉換器、OCR、PDF 翻譯 | [查看](docs/04-功能總覽.md) |
|
||||
| 🔗 **05 API 文件** | REST & GraphQL API | [查看](docs/05-API文件.md) |
|
||||
| 🔧 **06 錯誤排查** | 常見問題與解決方案 | [查看](docs/06-錯誤排查與支援.md) |
|
||||
| 👩💻 **07 開發指南** | 專案結構、貢獻規範 | [查看](docs/07-開發與貢獻指南.md) |
|
||||
| 📄 **08 授權說明** | AGPL-3.0 授權 | [查看](docs/08-授權說明.md) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -202,11 +202,11 @@ docker run -d \
|
|||
|
||||
### 授權摘要
|
||||
|
||||
| 權利 | 說明 |
|
||||
|------|------|
|
||||
| 權利 | 說明 |
|
||||
| ----------- | ------------------------ |
|
||||
| ✅ 自由使用 | 個人、商業、教育用途均可 |
|
||||
| ✅ 自由修改 | 可修改原始碼 |
|
||||
| ✅ 自由分發 | 可重新分發 |
|
||||
| ✅ 自由修改 | 可修改原始碼 |
|
||||
| ✅ 自由分發 | 可重新分發 |
|
||||
|
||||
### 義務
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue