docs: update project docs and evaluation history pagination
This commit is contained in:
@@ -76,7 +76,7 @@ fastapi/
|
||||
│ ├── schemas/ # Pydantic 入参/出参
|
||||
│ ├── services/ # 业务服务
|
||||
│ └── tasks/ # Celery 异步任务预留
|
||||
├── docs/ # API、架构、数据库、部署和交接文档
|
||||
├── docs/ # API、架构、数据库、部署和项目文档
|
||||
├── scripts/ # 初始化和维护脚本
|
||||
├── tests/ # 自动化测试
|
||||
├── Dockerfile
|
||||
@@ -90,8 +90,8 @@ fastapi/
|
||||
```powershell
|
||||
cd D:\Code\newfounder\medical-consultation-agent
|
||||
|
||||
python -m venv .venv
|
||||
.\.venv\Scripts\activate
|
||||
python -m venv backend\.venv
|
||||
.\backend\.venv\Scripts\activate
|
||||
pip install -r requirements.txt
|
||||
copy .env.example .env
|
||||
uvicorn app.main:app --host 127.0.0.1 --port 9000
|
||||
@@ -209,17 +209,20 @@ event: answer_done
|
||||
.\backend\.venv\Scripts\python.exe tests\test_api_contract.py
|
||||
```
|
||||
|
||||
## 9. 交接文档
|
||||
## 9. 项目文档
|
||||
|
||||
| 文档 | 用途 |
|
||||
|---|---|
|
||||
| `docs/00_project_overview.md` | 项目总览和功能讲解顺序 |
|
||||
| `docs/01_architecture.md` | 系统架构、调用链路和模块边界 |
|
||||
| `docs/02_database.md` | 核心数据库表和读写边界 |
|
||||
| `docs/03_api_design.md` | 前端联调 API 文档 |
|
||||
| `docs/04_deployment.md` | 云服务器部署、更新和回滚 |
|
||||
| `docs/05_modules.md` | 功能模块说明 |
|
||||
| `docs/06_handover.md` | 离职交接说明和风险清单 |
|
||||
| `docs/06_maintenance_guide.md` | 开发维护说明和风险清单 |
|
||||
| `docs/07_troubleshooting.md` | 常见故障排查 |
|
||||
| `docs/08_feature_code_map.md` | 功能到接口、代码和数据表的映射表 |
|
||||
| `docs/09_prompt_template_catalog.md` | 提示词模板目录和调用说明 |
|
||||
|
||||
## 10. 重要约定
|
||||
|
||||
|
||||
Reference in New Issue
Block a user