root
e3fa7e86f3
新的文档结构：
docs/
├── README.md # 文档中心导航
├── modules/ # 模块文档
│ ├── auth/ # 认证模块
│ │ ├── README.md
│ │ ├── feishu-login.md
│ │ ├── feishu-qrcode.md
│ │ └── feishu-notification.md
│ ├── approval/ # 审批流程模块
│ │ └── README.md
│ ├── business-trip/ # 出差申请模块
│ │ └── README.md
│ └── user/ # 用户管理模块
│ └── README.md
└── guides/ # 指南文档
├── deployment.md
├── environment.md
├── git-workflow.md
└── ...
每个模块都有独立的 README.md 说明概述、API、关键文件等
93 lines
2.4 KiB
Markdown
93 lines
2.4 KiB
Markdown
# X-Server Mobile 文档中心
|
|
|
|
## 📚 文档导航
|
|
|
|
### 快速开始
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [项目总览](PROJECT.md) | 项目介绍和技术栈 |
|
|
| [环境配置](guides/environment.md) | 开发/生产环境配置 |
|
|
| [Git 工作流程](guides/git-workflow.md) | 分支管理和协作流程 |
|
|
|
|
### 模块文档
|
|
|
|
| 模块 | 说明 | 负责人 |
|
|
|------|------|--------|
|
|
| [认证模块](modules/auth/README.md) | 登录、登出、Token 管理 | mzl |
|
|
| [审批流程](modules/approval/README.md) | 审批流程引擎 | - |
|
|
| [出差申请](modules/business-trip/README.md) | 出差申请业务 | - |
|
|
| [用户管理](modules/user/README.md) | 用户、公司、权限 | - |
|
|
|
|
### 部署指南
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [部署指南](guides/deployment.md) | 完整部署流程 |
|
|
| [部署检查清单](guides/DEPLOYMENT_CHECKLIST.md) | 上线前检查项 |
|
|
| [快速部署](guides/QUICK_DEPLOY.md) | 快速部署步骤 |
|
|
| [线上部署指南](guides/DEPLOY_ONLINE_GUIDE.md) | 生产环境部署 |
|
|
|
|
### 开发指南
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [反向代理配置](guides/REVERSE_PROXY_SETUP.md) | OpenResty 配置 |
|
|
| [开发环境代理](guides/DEV_REVERSE_PROXY_SETUP.md) | 本地开发代理 |
|
|
|
|
### 参考
|
|
|
|
| 文档 | 说明 |
|
|
|------|------|
|
|
| [历史问题汇总](PROJECT_ISSUES.md) | 开发中遇到的问题 |
|
|
| [实现计划](IMPLEMENTATION_PLAN.md) | 功能实现计划 |
|
|
| [数据库分析](database-analysis.md) | 数据库设计说明 |
|
|
|
|
---
|
|
|
|
## 🚀 快速链接
|
|
|
|
### 开发环境
|
|
```bash
|
|
# 启动前端
|
|
cd /www/x-server-mobile/frontend && npm run dev
|
|
|
|
# 启动后端
|
|
docker logs x-server-backend -f
|
|
```
|
|
|
|
### 常用命令
|
|
```bash
|
|
# 查看日志
|
|
docker logs x-server-backend -f --tail 50
|
|
|
|
# 重启后端
|
|
docker compose restart backend
|
|
|
|
# 数据库操作
|
|
docker exec -it 1Panel-mysql-409s mysql -uroot -pmysql_xEsdPa xserver
|
|
```
|
|
|
|
---
|
|
|
|
## 📋 文档规范
|
|
|
|
### 模块文档结构
|
|
```
|
|
docs/modules/{module-name}/
|
|
├── README.md # 模块概述（必需）
|
|
├── api.md # API 接口说明（可选）
|
|
├── database.md # 数据库设计（可选）
|
|
└── guide.md # 使用指南（可选）
|
|
```
|
|
|
|
### 文档编写规范
|
|
1. **README.md** 必须包含：概述、核心功能、API接口、关键文件
|
|
2. 使用表格列出关键信息
|
|
3. 代码块注明语言类型
|
|
4. 保持与代码同步更新
|
|
|
|
---
|
|
|
|
**最后更新**: 2026-02-28
|