docs(zh): fix document formatting and typography (#27)

Author: her-cat

docs/zh/development/advanced/CONTRIBUTING.md

@@ -28,4 +28,4 @@
 2. 提供复现问题的步骤（如果适用）
 3. 提供相关的日志或截图（如果适用）
 
-感谢您的贡献！ 
+感谢您的贡献！ 

docs/zh/development/advanced/init.md

@@ -18,7 +18,7 @@
 - 写入生产环境配置，包含部署类型、环境类型、私有配置等信息
 - 写入测试环境配置，便于开发和测试
 
-> **重要：** 系统生产环境ID为10000，请确保在环境变量中将`MAGIC_ENV_ID`设置为`10000`。
+> **重要：** 系统生产环境 ID 为 10000，请确保在环境变量中将 `MAGIC_ENV_ID` 设置为 `10000`。
 
 ## 3. 执行和测试步骤
 
@@ -53,4 +53,4 @@ curl -X POST -H "Content-Type: application/json" -d '{"email":"[email protected]
 - 账号 `13812345678`：密码为 `letsmagic.ai`
 - 账号 `13912345678`：密码为 `letsmagic.ai`
 
-在生产环境中，请确保实现安全的密码存储和验证机制。 
+在生产环境中，请确保实现安全的密码存储和验证机制。 

docs/zh/development/advanced/permission.md

@@ -184,4 +184,4 @@ vendor/bin/phpunit test/Cases/Infrastructure/Util/Auth/PermissionCheckerTest.php
   "magic_env_management": ["13800000014", "13800000015"],
   "service_provider_admin": ["13800000016", "13800000017"]
 }
-```
+```

docs/zh/development/deploy/docker.md

@@ -1,15 +1,15 @@
 
 ## 快速开始
-支持Mac os 和Liunx 操作系统,
-window 系统可以通过docker-compose运行
+支持 macOS 和 Linux 操作系统。Windows 系统可以通过 docker compose 运行
 ### 1. 克隆项目
 ```bash
 git clone https://github.com/dtyq/magic.git
 cd magic
 ```
 
 ### 2. 配置环境变量
-配置magic 环境变量, 必须配置任意一种大模型的环境变量才可正常使用magic
+配置 Magic 环境变量，必须配置任意一种大模型的环境变量才可正常使用 Magic。
+
 复制 `.env.example` 文件为 `.env`，并根据需要修改配置：
 ```bash
 cp .env.example .env
@@ -48,10 +48,10 @@ cp .env.example .env
 ```
 
 ### 4. 访问服务
-- API 服务: http://localhost:9501
-- Web 应用: http://localhost:8080
+- API 服务：http://localhost:9501
+- Web 应用：http://localhost:8080
   - 账号 `13812345678`：密码为 `letsmagic.ai`
   - 账号 `13912345678`：密码为 `letsmagic.ai`
-- RabbitMQ 管理界面: http://localhost:15672
-  - 用户名: admin
-  - 密码: magic123456
+- RabbitMQ 管理界面：http://localhost:15672
+  - 用户名：admin
+  - 密码：magic123456

docs/zh/development/deploy/environment.md

@@ -33,16 +33,16 @@ MAGIC_WEB_TAG=latest
 MAGIC_EDITION=COMMUNITY
 ```
 
-#### Git仓库配置
+#### Git 仓库配置
 
 ```
-# Git Repository URL (默认使用GitHub)
+# Git Repository URL (默认使用 GitHub)
 [email protected]:dtyq
 ```
 
 ### 2. 数据库配置
 
-#### MySQL配置
+#### MySQL 配置
 
 ```
 # MySQL 配置
@@ -56,7 +56,7 @@ MYSQL_WORK_MEM=4MB
 MYSQL_MAINTENANCE_WORK_MEM=64MB
 MYSQL_EFFECTIVE_CACHE_SIZE=4096MB
 
-# 应用MySQL连接配置
+# 应用 MySQL 连接配置
 DB_DRIVER=mysql
 DB_HOST=db
 DB_PORT=3306
@@ -68,32 +68,32 @@ DB_COLLATION=utf8mb4_unicode_ci
 DB_PREFIX=
 ```
 
-#### Redis配置
+#### Redis 配置
 
 ```
-# Redis配置
+# Redis 配置
 REDIS_HOST=redis
 REDIS_AUTH=magic123456
 REDIS_PORT=6379
 REDIS_DB=0
 REDIS_PASSWORD=magic123456
 ```
 
-#### RabbitMQ配置
+#### RabbitMQ 配置
 
 ```
-# RabbitMQ配置
+# RabbitMQ 配置
 AMQP_HOST=rabbitmq
 AMQP_PORT=5672
 AMQP_USER=admin
 AMQP_PASSWORD=magic123456
 AMQP_VHOST=magic-chat
 ```
 
-#### OpenSearch配置
+#### OpenSearch 配置
 
 ```
-# OpenSearch配置
+# OpenSearch 配置
 OPENSEARCH_DISCOVERY_TYPE=single-node
 OPENSEARCH_BOOTSTRAP_MEMORY_LOCK=true
 OPENSEARCH_JAVA_OPTS_MIN=512m
@@ -105,10 +105,10 @@ OPENSEARCH_NOFILE_SOFT=65536
 OPENSEARCH_NOFILE_HARD=65536
 ```
 
-#### Qdrant配置
+#### Qdrant 配置
 
 ```
-# Qdrant配置
+# Qdrant 配置
 QDRANT_API_KEY=magic123456
 ODIN_QDRANT_BASE_URI=http://qdrant
 ODIN_QDRANT_API_KEY=
@@ -141,7 +141,7 @@ ENABLE_CONSUME=true
 ENABLE_CHAT_MESSAGE=true
 # 启用聊天序列
 ENABLE_CHAT_SEQ=true
-# 启用Magic看门狗（本地开发可禁用）
+# 启用 Magic 看门狗（本地开发可禁用）
 ENABLE_MAGIC_WATCHDOG=false
 
 # 通用开关
@@ -153,9 +153,9 @@ DOUBAO_EMBEDDING_ENABLED=false
 MISC_DMETA_EMBEDDING_ENABLED=false
 ```
 
-### 4. AI模型配置
+### 4. AI 模型配置
 
-#### Azure OpenAI配置
+#### Azure OpenAI 配置
 
 ```
 # Azure OpenAI GPT-4
@@ -181,7 +181,7 @@ AZURE_OPENAI_4O_GLOBAL_DEPLOYMENT_NAME=gpt-4o-global
 #### 豆包模型配置
 
 ```
-# 豆包Pro 32k
+# 豆包 Pro 32k
 DOUBAO_PRO_32K_ENDPOINT=doubao-1.5-pro-32k
 DOUBAO_PRO_32K_API_KEY=
 DOUBAO_PRO_32K_BASE_URL=https://ark.cn-beijing.volces.com
@@ -193,7 +193,7 @@ DOUBAO_EMBEDDING_BASE_URL=https://ark.cn-beijing.volces.com
 DOUBAO_EMBEDDING_VECTOR_SIZE=2048
 ```
 
-#### DeepSeek模型配置
+#### DeepSeek 模型配置
 
 ```
 # DeepSeek R1
@@ -207,7 +207,7 @@ DEEPSEEK_V3_API_KEY=
 DEEPSEEK_V3_BASE_URL=https://api.deepseek.com
 ```
 
-#### 其他AI服务配置
+#### 其他 AI 服务配置
 
 ```
 # dmeta-embedding
@@ -223,13 +223,13 @@ MIRACLE_VISION_SECRET=
 
 ### 5. 外部服务配置
 
-#### Google搜索配置
+#### Google 搜索配置
 
 ```
-# Google搜索所需代理
+# Google 搜索所需代理
 HTTP_PROXY=
 GOOGLE_SEARCH_API_KEY=
-# 使用Google时，请指定搜索cx (GOOGLE_SEARCH_ENGINE_ID)
+# 使用 Google 时，请指定搜索 cx (GOOGLE_SEARCH_ENGINE_ID)
 GOOGLE_SEARCH_CX=
 BACKEND=GOOGLE
 RELATED_QUESTIONS=true
@@ -243,13 +243,13 @@ APP_ID=
 APP_SECRET=
 APP_CODE=
 
-# CODE白名单
+# CODE 白名单
 CODE_WHITE_ACCOUNT_ID=
 
-# 默认magic_environment ID
+# 默认 Magic 环境 ID
 DEFAULT_MAGIC_ENVIRONMENT_ID=
 
-# Magic environment ID
+# Magic 环境 ID
 MAGIC_ENV_ID=1000
 ```
 
@@ -260,7 +260,7 @@ MAGIC_ENV_ID=1000
 
 ```
 # 文件驱动
-FILE_DRIVER=local   # 可选值: local, oss, tos
+FILE_DRIVER=local   # 可选值：local/oss/tos
 ```
 
 #### 本地文件驱动配置
@@ -276,56 +276,56 @@ FILE_LOCAL_WRITE_HOST=    # 文件上传域名，例如：https://upload.example
 
 ```
 # 阿里云文件驱动配置 - 私有 
-FILE_PRIVATE_ALIYUN_ACCESS_ID=      # 阿里云AccessKey ID
-FILE_PRIVATE_ALIYUN_ACCESS_SECRET=  # 阿里云AccessKey Secret
-FILE_PRIVATE_ALIYUN_BUCKET=         # OSS存储桶名称
-FILE_PRIVATE_ALIYUN_ENDPOINT=       # OSS访问域名，例如：oss-cn-hangzhou.aliyuncs.com
-FILE_PRIVATE_ALIYUN_ROLE_ARN=       # 可选，用于STS临时授权的角色ARN
+FILE_PRIVATE_ALIYUN_ACCESS_ID=      # 阿里云 AccessKey ID
+FILE_PRIVATE_ALIYUN_ACCESS_SECRET=  # 阿里云 AccessKey Secret
+FILE_PRIVATE_ALIYUN_BUCKET=         # OSS 存储桶名称
+FILE_PRIVATE_ALIYUN_ENDPOINT=       # OSS 访问域名，例如：oss-cn-hangzhou.aliyuncs.com
+FILE_PRIVATE_ALIYUN_ROLE_ARN=       # 可选，用于 STS 临时授权的角色 ARN
 
 # 阿里云文件驱动配置 - 公有
-FILE_PUBLIC_ALIYUN_ACCESS_ID=       # 阿里云AccessKey ID
-FILE_PUBLIC_ALIYUN_ACCESS_SECRET=   # 阿里云AccessKey Secret
-FILE_PUBLIC_ALIYUN_BUCKET=          # OSS存储桶名称
-FILE_PUBLIC_ALIYUN_ENDPOINT=        # OSS访问域名
-FILE_PUBLIC_ALIYUN_ROLE_ARN=        # 可选，用于STS临时授权的角色ARN
+FILE_PUBLIC_ALIYUN_ACCESS_ID=       # 阿里云 AccessKey ID
+FILE_PUBLIC_ALIYUN_ACCESS_SECRET=   # 阿里云 AccessKey Secret
+FILE_PUBLIC_ALIYUN_BUCKET=          # OSS 存储桶名称
+FILE_PUBLIC_ALIYUN_ENDPOINT=        # OSS 访问域名
+FILE_PUBLIC_ALIYUN_ROLE_ARN=        # 可选，用于 STS 临时授权的角色 ARN
 ```
 
 #### 火山引擎存储配置
 
 ```
 # 火山云文件驱动配置 - 私有
-FILE_PRIVATE_TOS_REGION=     # TOS地域，例如：cn-beijing
-FILE_PRIVATE_TOS_ENDPOINT=   # TOS访问域名
-FILE_PRIVATE_TOS_AK=         # 火山引擎AccessKey
-FILE_PRIVATE_TOS_SK=         # 火山引擎SecretKey
-FILE_PRIVATE_TOS_BUCKET=     # TOS存储桶名称
-FILE_PRIVATE_TOS_TRN=        # 可选，用于STS临时授权的角色ARN
+FILE_PRIVATE_TOS_REGION=     # TOS 地域，例如：cn-beijing
+FILE_PRIVATE_TOS_ENDPOINT=   # TOS 访问域名
+FILE_PRIVATE_TOS_AK=         # 火山引擎 AccessKey
+FILE_PRIVATE_TOS_SK=         # 火山引擎 SecretKey
+FILE_PRIVATE_TOS_BUCKET=     # TOS 存储桶名称
+FILE_PRIVATE_TOS_TRN=        # 可选，用于 STS 临时授权的角色 ARN
 
 # 火山云文件驱动配置 - 公有
-FILE_PUBLIC_TOS_REGION=      # TOS地域
-FILE_PUBLIC_TOS_ENDPOINT=    # TOS访问域名
-FILE_PUBLIC_TOS_AK=          # 火山引擎AccessKey
-FILE_PUBLIC_TOS_SK=          # 火山引擎SecretKey
-FILE_PUBLIC_TOS_BUCKET=      # TOS存储桶名称
-FILE_PUBLIC_TOS_TRN=         # 可选，用于STS临时授权的角色ARN
+FILE_PUBLIC_TOS_REGION=      # TOS 地域
+FILE_PUBLIC_TOS_ENDPOINT=    # TOS 访问域名
+FILE_PUBLIC_TOS_AK=          # 火山引擎 AccessKey
+FILE_PUBLIC_TOS_SK=          # 火山引擎 SecretKey
+FILE_PUBLIC_TOS_BUCKET=      # TOS 存储桶名称
+FILE_PUBLIC_TOS_TRN=         # 可选，用于 STS 临时授权的角色 ARN
 ```
 
 ### 7. Web应用配置
 
 #### 前端服务配置
 
 ```
-# Web应用配置
+# Web 应用配置
 PORT=8080
 MAGIC_SOCKET_BASE_URL=ws://localhost:9502
 MAGIC_SERVICE_BASE_URL=http://localhost:9501
 ```
 
 ## 配置建议
 
-1. **开发环境**: 复制 `.env.example` 到 `.env`，根据本地环境调整配置
-2. **测试环境**: 使用与生产环境类似但资源较少的配置
-3. **生产环境**: 确保设置强密码，并使用更可靠的外部服务配置
+1. **开发环境**：复制 `.env.example` 到 `.env`，根据本地环境调整配置
+2. **测试环境**：使用与生产环境类似但资源较少的配置
+3. **生产环境**：确保设置强密码，并使用更可靠的外部服务配置
 
 ## 安全建议
 
@@ -336,7 +336,7 @@ MAGIC_SERVICE_BASE_URL=http://localhost:9501
 
 ## 文件驱动特别说明
 
-详细的文件驱动配置和使用方法可参考[文件驱动使用说明](./file-driver.md)。
+详细的文件驱动配置和使用方法可参考[文件驱动使用说明](file-driver.md)。
 
 ## 初次部署注意事项