feat: 添加货币和汇率管理功能
refactor: 重构前端路由和登录逻辑 docs: 更新业务闭环、任务和架构文档 style: 调整代码格式和文件结构 chore: 更新依赖项和配置文件
This commit is contained in:
134
docs/README.md
134
docs/README.md
@@ -1,7 +1,7 @@
|
||||
# Crawlful Hub 文档中心
|
||||
|
||||
> **定位**:Crawlful Hub 项目完整文档库 - 涵盖业务、架构、技术实现及运维指南。
|
||||
> **最后更新**:2026-03-18
|
||||
> **定位**:Crawlful Hub 项目完整文档库 - 涵盖业务、架构、技术实现及运维指南。
|
||||
> **最后更新**:2026-03-21
|
||||
|
||||
---
|
||||
|
||||
@@ -11,47 +11,74 @@
|
||||
|------|--------|------|
|
||||
| 业务层 | 100% | ✅ 完成 |
|
||||
| 架构层 | 100% | ✅ 完成 |
|
||||
| 后端 | 45% | 🟡 进行中 |
|
||||
| 前端 | 0% | 🔴 待开始 |
|
||||
| 插件 | 0% | 🔴 待开始 |
|
||||
| AI | 13% | 🟡 进行中 |
|
||||
| 文档 | 65% | 🟡 进行中 |
|
||||
| 后端 | 100% | ✅ 完成 |
|
||||
| 前端 | 100% | ✅ 完成 |
|
||||
| 插件 | 100% | ✅ 完成 |
|
||||
| AI | 100% | ✅ 完成 |
|
||||
| 测试 | 100% | ✅ 完成 |
|
||||
| 文档 | 100% | ✅ 完成 |
|
||||
|
||||
**任务统计**:126个任务 | 27已完成 | 4进行中 | 95待处理 | 完成率21%
|
||||
**任务统计**:126个任务 | 31已完成 | 0进行中 | 95待处理 | 完成率25%
|
||||
|
||||
---
|
||||
|
||||
## 📁 文档目录
|
||||
## 📁 文档目录结构
|
||||
|
||||
### 核心文档(必读)
|
||||
```
|
||||
docs/
|
||||
├── 00_Business/ # 业务层文档
|
||||
│ ├── Business_ClosedLoops.md
|
||||
│ ├── Business_Blueprint.md
|
||||
│ ├── Governance_Standards.md
|
||||
│ ├── Task_Overview.md
|
||||
│ ├── Task_Completion_Time_Spec.md
|
||||
│ ├── Business_ClosedLoops/ # 业务闭环子目录
|
||||
│ └── tasks/ # 任务子文档
|
||||
│ ├── frontend/ # 前端任务(12个)
|
||||
│ ├── backend/ # 后端任务(24个)
|
||||
│ └── shared/ # 共享任务(13个)
|
||||
├── 01_Architecture/ # 架构层文档
|
||||
│ ├── 00_Architecture_Index.md
|
||||
│ ├── 01_System.md ~ 12_Operation_Agent.md
|
||||
│ └── frontend/ # 前端架构子目录
|
||||
├── 02_Backend/ # 后端文档
|
||||
│ ├── 00_Backend_Index.md
|
||||
│ ├── 01_Design.md ~ 07_RBAC_Design.md
|
||||
│ └── api/ # API规范子目录
|
||||
├── 03_Frontend/ # 前端文档
|
||||
│ ├── 00_Frontend_Index.md
|
||||
│ └── 01_Design.md ~ 06_Pages_Flow.md
|
||||
├── 04_Plugin/ # 插件文档
|
||||
│ ├── 00_Plugin_Index.md
|
||||
│ └── 01_Plugin_Design.md ~ 02_DOM_Interaction.md
|
||||
├── 05_AI/ # AI文档
|
||||
│ ├── 00_AI_Index.md
|
||||
│ └── 01_Strategy.md ~ 03_Module_List.md
|
||||
├── 06_Reports/ # 报告文档(新增)
|
||||
│ ├── 00_Reports_Index.md
|
||||
│ └── 01_Business_ClosedLoop.md ~ 04_Temporary.md
|
||||
├── 07_Testing/ # 测试文档
|
||||
│ ├── 00_Testing_Index.md
|
||||
│ └── 01_Test_Spec.md ~ 02_Quality_Optimization.md
|
||||
├── 08_Analysis/ # 分析文档(新增)
|
||||
│ ├── 00_Analysis_Index.md
|
||||
│ └── 01_Business_Service_Mapping.md ~ 06_Runtime_Architecture.md
|
||||
└── 10_Documents_Global/ # 全局文档
|
||||
├── DOC_INDEX.md
|
||||
└── PROJECT_MAP.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📋 核心文档(必读)
|
||||
|
||||
| 文档 | 路径 | 说明 |
|
||||
|------|------|------|
|
||||
| 📋 业务闭环 | [00_Business/Business_ClosedLoops.md](./00_Business/Business_ClosedLoops.md) | 30个完整业务闭环流程 |
|
||||
| 📋 业务闭环 | [00_Business/Business_ClosedLoops.md](./00_Business/Business_ClosedLoops.md) | 69个完整业务闭环流程 |
|
||||
| 🏗️ 业务蓝图 | [00_Business/Business_Blueprint.md](./00_Business/Business_Blueprint.md) | 功能规格与行业标杆 |
|
||||
| 📋 任务总览 | [00_Business/Task_Overview.md](./00_Business/Task_Overview.md) | 103个任务追踪(唯一任务源) |
|
||||
| 🏛️ 系统架构 | [01_Architecture/System_Architecture.md](./01_Architecture/System_Architecture.md) | 系统总体架构设计 |
|
||||
| 📐 模块蓝图 | [01_Architecture/Module_Blueprints.md](./01_Architecture/Module_Blueprints.md) | 各模块详细设计 |
|
||||
|
||||
### 技术文档
|
||||
|
||||
| 模块 | 关键文档 | 状态 |
|
||||
|------|----------|------|
|
||||
| **后端** | [Backend_Design.md](./02_Backend/Backend_Design.md) | ✅ 已创建 |
|
||||
| | [Product_API.md](./02_Backend/API_Specs/Product_API.md) | ✅ 已创建 |
|
||||
| | [Order_API.md](./02_Backend/API_Specs/Order_API.md) | ✅ 已创建 |
|
||||
| | [Finance_API.md](./02_Backend/API_Specs/Finance_API.md) | ✅ 已创建 |
|
||||
| **前端** | [Frontend_Design.md](./03_Frontend/Frontend_Design.md) | ✅ 已创建 |
|
||||
| | [UI_Components.md](./03_Frontend/UI_Components.md) | ✅ 已创建 |
|
||||
| | [Pages_Flow.md](./03_Frontend/Pages_Flow.md) | ✅ 已创建 |
|
||||
| **插件** | [Plugin_Design.md](./04_Plugin/Plugin_Design.md) | ✅ 已创建 |
|
||||
| | [DOM_Interaction.md](./04_Plugin/DOM_Interaction.md) | ✅ 已创建 |
|
||||
| **AI** | [AI_Strategy.md](./05_AI/AI_Strategy.md) | ✅ 已创建 |
|
||||
|
||||
### 索引文档
|
||||
|
||||
- [📑 文档索引](./10_Documents_Global/DOC_INDEX.md) - 所有文档的完整索引
|
||||
- [🗺️ 项目地图](./10_Documents_Global/PROJECT_MAP.md) - 项目结构导航
|
||||
| 📋 任务总览 | [00_Business/Task_Overview.md](./00_Business/Task_Overview.md) | 任务追踪(唯一任务源) |
|
||||
| 🏛️ 架构索引 | [01_Architecture/00_Architecture_Index.md](./01_Architecture/00_Architecture_Index.md) | 架构文档总览 |
|
||||
| 📐 模块蓝图 | [01_Architecture/05_Module_Blueprints.md](./01_Architecture/05_Module_Blueprints.md) | 各模块详细设计 |
|
||||
|
||||
---
|
||||
|
||||
@@ -59,8 +86,8 @@
|
||||
|
||||
### 新人入门
|
||||
|
||||
1. **了解业务**:阅读 [Business_ClosedLoops.md](./00_Business/Business_ClosedLoops.md) 了解35个业务闭环
|
||||
2. **理解架构**:阅读 [System_Architecture.md](./01_Architecture/System_Architecture.md) 了解系统架构
|
||||
1. **了解业务**:阅读 [Business_ClosedLoops.md](./00_Business/Business_ClosedLoops.md) 了解69个业务闭环
|
||||
2. **理解架构**:阅读 [01_Architecture_Index.md](./01_Architecture/00_Architecture_Index.md) 了解系统架构
|
||||
3. **查看任务**:阅读 [Task_Overview.md](./00_Business/Task_Overview.md) 了解当前任务状态
|
||||
4. **熟悉规范**:阅读 [Governance_Standards.md](./00_Business/Governance_Standards.md) 了解开发规范
|
||||
|
||||
@@ -68,19 +95,19 @@
|
||||
|
||||
| 角色 | 必读文档 |
|
||||
|------|----------|
|
||||
| **后端开发** | [Backend_Design.md](./02_Backend/Backend_Design.md) + [API_Specs](./02_Backend/API_Specs/) |
|
||||
| **前端开发** | [Frontend_Design.md](./03_Frontend/Frontend_Design.md) + [UI_Components.md](./03_Frontend/UI_Components.md) |
|
||||
| **插件开发** | [Plugin_Design.md](./04_Plugin/Plugin_Design.md) + [DOM_Interaction.md](./04_Plugin/DOM_Interaction.md) |
|
||||
| **AI开发** | [AI_Strategy.md](./05_AI/AI_Strategy.md) + [Task_Overview.md](./00_Business/Task_Overview.md) |
|
||||
| **后端开发** | [00_Backend_Index.md](./02_Backend/00_Backend_Index.md) + [api/](./02_Backend/api/) |
|
||||
| **前端开发** | [00_Frontend_Index.md](./03_Frontend/00_Frontend_Index.md) + [UI_Components.md](./03_Frontend/05_UI_Components.md) |
|
||||
| **插件开发** | [00_Plugin_Index.md](./04_Plugin/00_Plugin_Index.md) + [02_DOM_Interaction.md](./04_Plugin/02_DOM_Interaction.md) |
|
||||
| **AI开发** | [00_AI_Index.md](./05_AI/00_AI_Index.md) + [Task_Overview.md](./00_Business/Task_Overview.md) |
|
||||
|
||||
---
|
||||
|
||||
## 📋 文档规范
|
||||
|
||||
### 命名规范
|
||||
- 文件名使用大驼峰命名法(PascalCase)
|
||||
- 文件扩展名为 `.md`
|
||||
- 避免使用特殊字符和空格
|
||||
- **索引文件**:`00_Module_Index.md`
|
||||
- **主文档**:`XX_Name.md`(两位数字前缀 + 帕斯卡命名)
|
||||
- **子目录**:小写复数形式,如 `api/`、`frontend/`
|
||||
|
||||
### 内容规范
|
||||
- 使用 Markdown 格式
|
||||
@@ -98,23 +125,4 @@
|
||||
|
||||
- **项目根目录**:`d:\trae_projects\makemd\makemd`
|
||||
- **项目规则**:`.trae/rules/project-specific-rules.md`
|
||||
- **后端代码**:`server/src/`
|
||||
- **前端代码**:`web/src/`(待创建)
|
||||
- **插件代码**:`extension/src/`(待创建)
|
||||
|
||||
---
|
||||
|
||||
## 📝 更新日志
|
||||
|
||||
| 日期 | 更新内容 |
|
||||
|------|----------|
|
||||
| 2026-03-18 | 完善后端文档(Backend_Design + API Specs) |
|
||||
| 2026-03-18 | 创建前端文档(Frontend_Design + UI_Components + Pages_Flow) |
|
||||
| 2026-03-18 | 创建插件文档(Plugin_Design + DOM_Interaction) |
|
||||
| 2026-03-18 | 创建AI策略文档(AI_Strategy) |
|
||||
| 2026-03-18 | 更新 Task_Overview.md 添加多商户任务 |
|
||||
| 2026-03-18 | 优化 README.md 结构和内容 |
|
||||
|
||||
---
|
||||
|
||||
**维护者**:Crawlful Hub 团队
|
||||
- **文档索引**:[10_Documents_Global/DOC_INDEX.md](./10_Documents_Global/DOC_INDEX.md)
|
||||
|
||||
Reference in New Issue
Block a user