From 6f451757f2214df4a9067caf8f8d01bc337e167c Mon Sep 17 00:00:00 2001 From: AI Clinical Dev Team Date: Fri, 10 Oct 2025 17:44:15 +0800 Subject: [PATCH] docs: optimize README navigation links --- README.md | 32 ++++++++++++++++++++++++-------- backend/README.md | 9 +++++++++ docs/README.md | 9 +++++++++ frontend/README.md | 9 +++++++++ 4 files changed, 51 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 33adcc50..0a04f230 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,19 @@ ## 📚 项目文档 -完整的项目文档位于 `docs/` 目录: +### 📖 文档导航中心 +- **[📚 完整文档导航](./docs/README.md)** ⭐ 查看所有设计文档和开发规范 -- [产品需求文档(PRD)](./docs/00-项目概述/产品需求文档(PRD).md) -- [技术架构总览](./docs/00-项目概述/技术架构总览.md) -- [数据库设计文档](./docs/01-设计文档/数据库设计文档.md) -- [API设计规范](./docs/01-设计文档/API设计规范.md) -- [开发里程碑](./docs/04-开发计划/开发里程碑.md) +### 🔗 快速链接 +- [产品需求文档(PRD)](./docs/00-项目概述/产品需求文档(PRD).md) - 了解产品需求 +- [技术架构总览](./docs/00-项目概述/技术架构总览.md) - 了解技术方案 +- [数据库设计文档](./docs/01-设计文档/数据库设计文档.md) - 理解数据结构 +- [API设计规范](./docs/01-设计文档/API设计规范.md) - 掌握接口定义 +- [开发里程碑](./docs/04-开发计划/开发里程碑.md) - 查看开发进度 + +### 🛠️ 子项目文档 +- **[⚙️ 后端开发指南](./backend/README.md)** - Node.js + Fastify + Prisma +- **[🎨 前端开发指南](./frontend/README.md)** - React + TypeScript + Ant Design ## 🏗️ 技术栈 @@ -82,6 +88,16 @@ MIT --- -**当前开发阶段:** 里程碑1 - Day 4(环境搭建) -**开发进度:** 设计阶段已完成,正在进行基础搭建 +## 🔗 相关链接 + +- [📚 文档中心](./docs/README.md) - 完整的项目文档导航 +- [⚙️ 后端项目](./backend/README.md) - 后端开发指南 +- [🎨 前端项目](./frontend/README.md) - 前端开发指南 +- [🚀 快速启动指南](./启动指南.md) - 一步步启动项目 +- [🐳 Dify部署方案](./Dify完整部署方案.md) - Dify部署指南 + +--- + +**当前开发阶段:** 里程碑1 - Day 6(前端基础架构) +**开发进度:** 50% - 前后端基础架构已完成 diff --git a/backend/README.md b/backend/README.md index cefb148c..4bc6a606 100644 --- a/backend/README.md +++ b/backend/README.md @@ -1,5 +1,14 @@ # AI临床研究平台 - 后端服务 +## 🏠 导航 + +- [← 返回项目主页](../README.md) +- [📚 查看完整文档](../docs/README.md) +- [🎨 前端项目](../frontend/README.md) +- [🚀 快速启动指南](../启动指南.md) + +--- + ## 快速开始 ### 1. 环境要求 diff --git a/docs/README.md b/docs/README.md index 9efdad73..8504a944 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,14 @@ # AI科研助手 - 文档中心 +## 🏠 导航 + +- [← 返回项目主页](../README.md) +- [⚙️ 后端开发指南](../backend/README.md) +- [🎨 前端开发指南](../frontend/README.md) +- [🚀 快速启动指南](../启动指南.md) + +--- + ## 📚 文档导航 ### 00-项目概述 diff --git a/frontend/README.md b/frontend/README.md index 85657f4d..49161a38 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -2,6 +2,15 @@ 基于 Vite + React + TypeScript + Ant Design 构建 +## 🏠 导航 + +- [← 返回项目主页](../README.md) +- [📚 查看完整文档](../docs/README.md) +- [⚙️ 后端项目](../backend/README.md) +- [🚀 快速启动指南](../启动指南.md) + +--- + ## 🚀 快速开始 ### 1. 安装依赖