新增:文档体系重构+CHANGELOG补充+发布产物清理
This commit is contained in:
120
docs/INDEX.md
Normal file
120
docs/INDEX.md
Normal file
@@ -0,0 +1,120 @@
|
||||
# U-Desk 文档索引
|
||||
|
||||
> 更新日期:2026-05-01
|
||||
> 分支: `fs-only-v3` (Wails v3)
|
||||
> 参考 [wk-flux/docs](../../wk-flux/docs) 目录结构
|
||||
|
||||
---
|
||||
|
||||
## 目录结构
|
||||
|
||||
```
|
||||
docs/
|
||||
├── INDEX.md # 本文件
|
||||
├── 01-技术文档/ # 技术文档和专题研究
|
||||
│ ├── CodeMirror/ # CodeMirror 6 编辑器系列(6篇)
|
||||
│ └── 数据库优化/ # 数据库连接池、缓存优化(2篇)
|
||||
├── 02-架构设计/ # 架构设计、改进方案、迁移记录
|
||||
│ ├── OOP架构/ # OOP vs Composables 架构对比(6篇)
|
||||
│ ├── Pinia迁移/ # Pinia 状态管理迁移(5篇)
|
||||
│ └── 插件系统方案.md
|
||||
├── 03-模块文档/ # 各功能模块实现文档
|
||||
│ ├── 文件系统/ # 文件管理模块(14篇)
|
||||
│ ├── 更新通知/ # 更新通知模块(10篇)
|
||||
│ ├── 设置功能/ # 设置模块(4篇)
|
||||
│ ├── 文件内容/ # 文件内容模块(2篇)
|
||||
│ └── 启动优化/ # 启动优化模块(3篇)
|
||||
├── 04-功能迭代/ # 历史功能迭代文档
|
||||
│ ├── GO-DESK-1.尝试/ # 应用初始化阶段
|
||||
│ ├── GO-DESK-2.数据库客户端/ # 数据库客户端(39篇,已移除)
|
||||
│ ├── GO-DESK-3.文件系统/ # 文件系统管理
|
||||
│ ├── GO-DESK-4.AI工作台/ # AI 工作台
|
||||
│ ├── GO-DESK-6.文件操作增强/ # 文件操作增强
|
||||
│ └── GO-DESK-7.u-fs-agent远程文件服务/ # 远程文件服务
|
||||
├── 05-代码审查/ # 代码审查、走查报告、重构记录
|
||||
│ ├── 审查报告/ # 各期代码审查报告
|
||||
│ ├── 代码质量/ # 代码质量优化(3篇)
|
||||
│ └── 分析报告/ # 各类分析报告(6篇)
|
||||
├── 06-前端开发/ # 前端分析与优化
|
||||
│ ├── 布局分析/
|
||||
│ ├── 代码分割/
|
||||
│ ├── 组件分析/
|
||||
│ └── 编译器未发现的初始化问题.md
|
||||
├── 07-项目管理/ # 项目规划与版本管理
|
||||
│ ├── 项目规划/ # PROJECT_STATUS、work-plan
|
||||
│ ├── 功能清单/ # 功能清单与核对报告
|
||||
│ └── 版本管理/ # changelog、版本发布手册
|
||||
├── 08-用户指南/ # 用户手册和配置指南
|
||||
│ ├── u-desk-site/ # 官网(单页设计,部署至 /var/www/u-desk-site/)
|
||||
│ │ ├── index.html # 首页(Hero + 功能 + 文档 + 下载)
|
||||
│ │ ├── changelog.html # 版本历史记录页(时间线样式,7个版本完整日志)
|
||||
│ │ ├── docs.html # 详细文档页
|
||||
│ │ ├── privacy.html # 隐私声明
|
||||
│ │ └── download/ # 安装包(Windows exe / Linux)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 快速导航
|
||||
|
||||
| 分类 | 入口 | 说明 |
|
||||
|------|------|------|
|
||||
| 技术文档 | [01-技术文档/](./01-技术文档/) | CodeMirror、数据库优化等专题 |
|
||||
| 架构设计 | [02-架构设计/](./02-架构设计/) | 架构方案、迁移记录、设计决策 |
|
||||
| 模块文档 | [03-模块文档/](./03-模块文档/) | 各功能模块的实现和优化记录 |
|
||||
| 功能迭代 | [04-功能迭代/](./04-功能迭代/) | 历史功能开发过程文档 |
|
||||
| 代码审查 | [05-代码审查/](./05-代码审查/) | 审查报告、走查报告、重构记录 |
|
||||
| 前端开发 | [06-前端开发/](./06-前端开发/) | 前端分析、优化、问题排查 |
|
||||
| 项目管理 | [07-项目管理/](./07-项目管理/) | 项目状态、功能清单、版本管理 |
|
||||
| 用户指南 | [08-用户指南/](./08-用户指南/) | 用户手册、配置指南 |
|
||||
|
||||
---
|
||||
|
||||
## 新文档放置规则
|
||||
|
||||
| 文档类型 | 放置位置 |
|
||||
|----------|----------|
|
||||
| 技术专题研究 | `01-技术文档/<专题名>/` |
|
||||
| 架构设计/改进方案 | `02-架构设计/` |
|
||||
| 功能模块实现文档 | `03-模块文档/<模块名>/` |
|
||||
| 功能开发过程记录 | `04-功能迭代/GO-DESK-N.<模块>/` |
|
||||
| 代码审查/走查报告 | `05-代码审查/审查报告/` |
|
||||
| 前端优化分析 | `06-前端开发/` |
|
||||
| 项目状态/功能清单 | `07-项目管理/` |
|
||||
| 用户手册/配置指南 | `08-用户指南/` |
|
||||
|
||||
---
|
||||
|
||||
## 技术栈
|
||||
|
||||
- **后端**: Go 1.26 + Wails v3 (alpha.80)
|
||||
- **前端**: Vue 3 + TypeScript + Arco Design Vue + Pinia
|
||||
- **编辑器**: CodeMirror 6
|
||||
- **构建**: Vite 7 + Taskfile
|
||||
- **桌面端**: 原生窗口(macOS/Windows/Linux)
|
||||
- **数据库**: SQLite(本地配置存储)
|
||||
- **当前版本**: 0.5.0
|
||||
|
||||
> 注:v0.4.0 起已移除 MySQL/Redis/MongoDB 数据库客户端模块,专注文件管理功能。
|
||||
|
||||
## 项目结构(当前)
|
||||
|
||||
```
|
||||
u-desk/
|
||||
├── main.go # 入口:窗口配置、中间件、DevTools
|
||||
├── app.go # 应用逻辑:文件系统、更新检查等
|
||||
├── wails.json # Wails 项目配置
|
||||
├── internal/ # 内部模块
|
||||
│ ├── filesystem/ # 文件操作、锁、预览服务
|
||||
│ └── agent/ # 远程文件服务 Agent
|
||||
├── frontend/ # 前端代码 (Vue 3) ← 原 web/
|
||||
│ ├── src/
|
||||
│ │ ├── components/FileSystem/ # 文件管理主组件
|
||||
│ │ ├── stores/ # Pinia 状态管理
|
||||
│ │ ├── api/ # 后端调用封装(Transport 抽象)
|
||||
│ │ └── utils/ # 工具函数
|
||||
│ └── vite.config.js
|
||||
├── build/ # 构建配置(跨平台)
|
||||
├── cmd/ # 命令行入口
|
||||
└── configs/ # 运行时配置
|
||||
```
|
||||
Reference in New Issue
Block a user