docs: 将文档链接路径统一迁移到docs目录下
This commit is contained in:
64
README.md
64
README.md
@ -6,39 +6,39 @@
|
||||
|
||||
### 🏗️ 架构文档
|
||||
|
||||
- **[项目概览](PROJECT_OVERVIEW.md)** - UdminAI 项目的整体介绍、技术架构和核心功能
|
||||
- **[后端架构](BACKEND_ARCHITECTURE.md)** - 后端系统的详细架构设计和模块组织
|
||||
- **[前端架构](FRONTEND_ARCHITECTURE.md)** - 前端应用的架构设计、技术栈和组件体系
|
||||
- **[项目概览](docs/PROJECT_OVERVIEW.md)** - UdminAI 项目的整体介绍、技术架构和核心功能
|
||||
- **[后端架构](docs/BACKEND_ARCHITECTURE.md)** - 后端系统的详细架构设计和模块组织
|
||||
- **[前端架构](docs/FRONTEND_ARCHITECTURE.md)** - 前端应用的架构设计、技术栈和组件体系
|
||||
|
||||
### 🔧 核心模块
|
||||
|
||||
- **[流程引擎](FLOW_ENGINE.md)** - 流程编排引擎的设计原理、执行机制和扩展能力
|
||||
- **[服务层](SERVICES.md)** - 业务服务层的设计模式、核心服务和集成方式
|
||||
- **[路由层](ROUTES.md)** - API 路由的设计规范、接口定义和中间件集成
|
||||
- **[数据模型](MODELS.md)** - 数据模型的设计原则、实体定义和关系映射
|
||||
- **[中间件](MIDDLEWARES.md)** - 中间件系统的设计理念、核心组件和使用方式
|
||||
- **[流程引擎](docs/FLOW_ENGINE.md)** - 流程编排引擎的设计原理、执行机制和扩展能力
|
||||
- **[服务层](docs/SERVICES.md)** - 业务服务层的设计模式、核心服务和集成方式
|
||||
- **[路由层](docs/ROUTES.md)** - API 路由的设计规范、接口定义和中间件集成
|
||||
- **[数据模型](docs/MODELS.md)** - 数据模型的设计原则、实体定义和关系映射
|
||||
- **[中间件](docs/MIDDLEWARES.md)** - 中间件系统的设计理念、核心组件和使用方式
|
||||
|
||||
### 🛠️ 基础设施
|
||||
|
||||
- **[数据库](DATABASE.md)** - 数据库连接管理、查询优化和性能调优
|
||||
- **[错误处理](ERROR_HANDLING.md)** - 统一错误处理机制、错误类型定义和处理策略
|
||||
- **[响应格式](RESPONSE.md)** - API 响应格式规范、数据结构和最佳实践
|
||||
- **[工具函数](UTILS.md)** - 通用工具函数库、辅助工具和实用程序
|
||||
- **[数据库](docs/DATABASE.md)** - 数据库连接管理、查询优化和性能调优
|
||||
- **[错误处理](docs/ERROR_HANDLING.md)** - 统一错误处理机制、错误类型定义和处理策略
|
||||
- **[响应格式](docs/RESPONSE.md)** - API 响应格式规范、数据结构和最佳实践
|
||||
- **[工具函数](docs/UTILS.md)** - 通用工具函数库、辅助工具和实用程序
|
||||
|
||||
### 📋 专项文档
|
||||
|
||||
- **[Redis 集成](REDIS_INTEGRATION.md)** - Redis 缓存系统的集成方案和使用指南
|
||||
- **[ID 生成分析](ID_GENERATION_ANALYSIS.md)** - 分布式 ID 生成策略和实现分析
|
||||
- **[Redis 集成](docs/REDIS_INTEGRATION.md)** - Redis 缓存系统的集成方案和使用指南
|
||||
- **[ID 生成分析](docs/ID_GENERATION_ANALYSIS.md)** - 分布式 ID 生成策略和实现分析
|
||||
|
||||
### 🎯 流程编辑器
|
||||
|
||||
- **[变量节点使用](variable-node-usage.md)** - 流程变量节点的使用方法和最佳实践
|
||||
- **[固定布局演示](flow-fixed-layout-demo.md)** - 固定布局流程编辑器的演示和说明
|
||||
- **[自由布局演示](flow-free-layout-demo.md)** - 自由布局流程编辑器的功能展示
|
||||
- **[基础自由布局](flow-free-layout-base-demo.md)** - 自由布局的基础功能和操作指南
|
||||
- **[简单自由布局](flow-free-layout-simple-demo.md)** - 简化版自由布局编辑器的使用说明
|
||||
- **[自由布局 JSON](flow-free-layout-json.md)** - 自由布局的 JSON 数据结构定义
|
||||
- **[SJ 自由布局演示](flow-free-layout-sj-demo.md)** - SJ 版本自由布局编辑器的特性说明
|
||||
- **[变量节点使用](docs/variable-node-usage.md)** - 流程变量节点的使用方法和最佳实践
|
||||
- **[固定布局演示](docs/flow-fixed-layout-demo.md)** - 固定布局流程编辑器的演示和说明
|
||||
- **[自由布局演示](docs/flow-free-layout-demo.md)** - 自由布局流程编辑器的功能展示
|
||||
- **[基础自由布局](docs/flow-free-layout-base-demo.md)** - 自由布局的基础功能和操作指南
|
||||
- **[简单自由布局](docs/flow-free-layout-simple-demo.md)** - 简化版自由布局编辑器的使用说明
|
||||
- **[自由布局 JSON](docs/flow-free-layout-json.md)** - 自由布局的 JSON 数据结构定义
|
||||
- **[SJ 自由布局演示](docs/flow-free-layout-sj-demo.md)** - SJ 版本自由布局编辑器的特性说明
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
@ -46,27 +46,27 @@
|
||||
|
||||
如果你是第一次接触 UdminAI 项目,建议按以下顺序阅读文档:
|
||||
|
||||
1. **[项目概览](PROJECT_OVERVIEW.md)** - 了解项目整体架构和核心概念
|
||||
2. **[后端架构](BACKEND_ARCHITECTURE.md)** - 理解后端系统的设计思路
|
||||
3. **[前端架构](FRONTEND_ARCHITECTURE.md)** - 掌握前端应用的组织结构
|
||||
4. **[流程引擎](FLOW_ENGINE.md)** - 深入了解核心的流程编排能力
|
||||
1. **[项目概览](docs/PROJECT_OVERVIEW.md)** - 了解项目整体架构和核心概念
|
||||
2. **[后端架构](docs/BACKEND_ARCHITECTURE.md)** - 理解后端系统的设计思路
|
||||
3. **[前端架构](docs/FRONTEND_ARCHITECTURE.md)** - 掌握前端应用的组织结构
|
||||
4. **[流程引擎](docs/FLOW_ENGINE.md)** - 深入了解核心的流程编排能力
|
||||
|
||||
### 开发者指南
|
||||
|
||||
对于参与开发的团队成员,重点关注以下文档:
|
||||
|
||||
- **[服务层](SERVICES.md)** - 业务逻辑的实现规范
|
||||
- **[路由层](ROUTES.md)** - API 接口的设计标准
|
||||
- **[数据模型](MODELS.md)** - 数据结构的定义规则
|
||||
- **[错误处理](ERROR_HANDLING.md)** - 错误处理的统一方案
|
||||
- **[服务层](docs/SERVICES.md)** - 业务逻辑的实现规范
|
||||
- **[路由层](docs/ROUTES.md)** - API 接口的设计标准
|
||||
- **[数据模型](docs/MODELS.md)** - 数据结构的定义规则
|
||||
- **[错误处理](docs/ERROR_HANDLING.md)** - 错误处理的统一方案
|
||||
|
||||
### 运维指南
|
||||
|
||||
对于系统运维和部署,参考以下文档:
|
||||
|
||||
- **[数据库](DATABASE.md)** - 数据库的配置和优化
|
||||
- **[Redis 集成](REDIS_INTEGRATION.md)** - 缓存系统的部署和管理
|
||||
- **[中间件](MIDDLEWARES.md)** - 中间件的配置和监控
|
||||
- **[数据库](docs/DATABASE.md)** - 数据库的配置和优化
|
||||
- **[Redis 集成](docs/REDIS_INTEGRATION.md)** - 缓存系统的部署和管理
|
||||
- **[中间件](docs/MIDDLEWARES.md)** - 中间件的配置和监控
|
||||
|
||||
## 📖 文档约定
|
||||
|
||||
|
||||
Reference in New Issue
Block a user