修复: DOC-02+03+04 模块文档+使用手册重写对齐真实代码
- DOC-02 df-nodes: 8 节点虚构→3 实际(Ai/Script/Human 全完整实现),删 5 虚构节点(Docker/Git/Notify/HTTP/Subflow)+5 虚构 *_node.rs 文件行,补每节点真实实现要点。 - DOC-03 df-ai: 删虚构 router.rs(ModelRouter)+stream.rs(StreamCollector),trait 删 supported_features 改 endpoint(),工具数 12→19(tool_registry.rs 实际核对,核对报告 §3 称 13 亦滞后)。 - DOC-04 使用手册: 7 处过期修正(bun→npm / 任务状态 4→7 态 / 优先级 P0→P3 数字越小越高 / 节点 Script/Ai/Human / EventBus tokio broadcast 非 WebSocket / 多 Provider / 知识库 Tier1 AI 提炼+向量检索)。 主代理抽查:df-nodes 虚构节点仅历史说明残留 / 使用手册 bun 零命中。批3
This commit is contained in:
@@ -1,6 +1,8 @@
|
||||
# DevFlow 使用手册
|
||||
|
||||
> "本地优先的个人开发流程驾驶舱"
|
||||
>
|
||||
> 本手册对齐真实代码(核对基准 2026-06-15)。命令、状态枚举、节点类型均以 `package.json` / `crates/df-core/src/types.rs` / `crates/df-nodes/src/` 为准。
|
||||
|
||||
```mermaid
|
||||
graph LR
|
||||
@@ -21,9 +23,18 @@ graph LR
|
||||
## 🚀 快速开始
|
||||
|
||||
### 运行应用
|
||||
|
||||
```bash
|
||||
bun install
|
||||
bun run tauri dev
|
||||
npm install
|
||||
npm run tauri dev
|
||||
```
|
||||
|
||||
> 命令来源:`package.json` 的 `scripts`(`dev` / `build` / `tauri`)。不要使用 `bun`,仓库脚本统一走 npm(如 `dev:restart` 内部调用 `npm run dev:stop`)。
|
||||
|
||||
构建发布包:
|
||||
|
||||
```bash
|
||||
npm run tauri build
|
||||
```
|
||||
|
||||
### 一句话功能
|
||||
@@ -35,8 +46,8 @@ bun run tauri dev
|
||||
|
||||
#### 1. 任务管理
|
||||
- **创建任务**:指定项目、标题、分支名
|
||||
- **状态流转**:待开始 → 进行中 → 待审查 → 已合并
|
||||
- **优先级**:P0(紧急)到 P3(低)
|
||||
- **状态流转**:见下方「任务状态」7 态
|
||||
- **优先级**:P0(紧急)到 P3(低),数字越小优先级越高
|
||||
|
||||
#### 2. 分支绑定
|
||||
```bash
|
||||
@@ -56,7 +67,7 @@ bun run tauri dev
|
||||
## 📋 功能模块
|
||||
|
||||
### 🤖 AI Chat
|
||||
- **单 Provider**:简化配置
|
||||
- **多 Provider**:支持配置多个 AI 提供商(OpenAI / GLM / DeepSeek / Claude 兼容模式 / Anthropic 原生协议),可在「设置」中管理并指定默认
|
||||
- **工具调用**:代码生成、分析
|
||||
- **流式响应**:实时输出
|
||||
|
||||
@@ -69,12 +80,13 @@ bun run tauri dev
|
||||
- **状态同步**:与 Git 分支联动
|
||||
|
||||
### 📚 知识库(收藏夹)
|
||||
- **静态收集**:个人经验碎片
|
||||
- **分类管理**:审查规则、Prompt模板、踩坑经验
|
||||
- **快速搜索**:标题、标签、内容
|
||||
- **Tier1 AI 提炼**:从 AI 对话/工作流中自动提炼候选经验条目,附带 `reasoning`("为何值得沉淀")判断依据
|
||||
- **向量检索**:知识条目带 `embedding` 列,支持语义检索(OpenAI 兼容 `/v1/embeddings`,Anthropic 协议不支持 embedding)
|
||||
- **分类管理**:审查规则、Prompt模板、踩坑经验等 7 种 kind
|
||||
- **生命线管理**:candidate → pending_review → published → archived,带 reuse_count / verified 信号
|
||||
|
||||
### ⚙️ 设置
|
||||
- **AI 配置**:Provider、模型选择
|
||||
- **AI 配置**:多 Provider 管理(新增/编辑/删除/设默认)、模型选择
|
||||
- **通用设置**:主题、语言
|
||||
|
||||
## 🔧 核心功能详解
|
||||
@@ -142,18 +154,21 @@ bun run tauri dev
|
||||
- **隐私保护**:代码不出本地
|
||||
|
||||
### 实时监控
|
||||
- **事件流**:WebSocket 实时更新
|
||||
- **事件流**:基于 Tauri 的 EventBus(进程内 `tokio::sync::broadcast` 发布/订阅,前端经 `@tauri-apps/api/event` 的 emit/listen 接收),非 WebSocket
|
||||
- **进度显示**:工作流执行进度
|
||||
- **错误提示**:失败原因分析
|
||||
|
||||
### 工作流节点
|
||||
```typescript
|
||||
// 支持的节点类型
|
||||
- Script:执行 Shell 命令
|
||||
- Human:人工审批
|
||||
- Condition:条件判断
|
||||
- Parallel:并行执行
|
||||
```
|
||||
|
||||
实际内置 3 种节点类型(均在 `crates/df-nodes/src/` 完整实现):
|
||||
|
||||
| 节点 | 文件 | 作用 |
|
||||
|------|------|------|
|
||||
| **Script** | `script_node.rs` | 执行 Shell 命令(经 `df-execute::shell`),支持 `command` / `timeout_secs` / `working_dir`,非零退出码即失败 |
|
||||
| **Ai** | `ai_node.rs` | 调用 LLM 完成生成/分析(OpenAI 兼容 + Anthropic 协议),由 DAG Executor 自动驱动 |
|
||||
| **Human** | `human_node.rs` | 人工审批(subscribe → 发 HumanApprovalRequest → select! 等待响应),支持单选/多选 |
|
||||
|
||||
> 不存在独立的 Condition / Parallel / Docker / Git / Notify / HTTP / Subflow 节点。条件分支由工作流引擎层处理。
|
||||
|
||||
## 📊 使用统计
|
||||
|
||||
@@ -175,12 +190,20 @@ bun run tauri dev
|
||||
- **警告色**:黄色(#F59E0B)
|
||||
- **错误色**:红色(#EF4444)
|
||||
|
||||
### 图标含义
|
||||
- 📋:待开始
|
||||
- 🔨:进行中
|
||||
- 👀:待审查
|
||||
- ✅:已合并
|
||||
- 🗑️:已废弃
|
||||
### 任务状态图标含义
|
||||
任务共 7 个状态(对齐 `crates/df-core/src/types.rs` 的 `TaskStatus` 枚举):
|
||||
|
||||
| 状态值 | 含义 | 图标建议 |
|
||||
|--------|------|----------|
|
||||
| `todo` | 待开始 | 📋 |
|
||||
| `in_progress` | 进行中 | 🔨 |
|
||||
| `in_review` | 代码审查中 | 👀 |
|
||||
| `testing` | 测试中 | 🧪 |
|
||||
| `done` | 已完成 | ✅ |
|
||||
| `blocked` | 已阻塞 | 🚫 |
|
||||
| `cancelled` | 已取消 | 🗑️ |
|
||||
|
||||
> 分支状态另设 3 态:`active` / `merged` / `abandoned`(见 `BranchStatus` 枚举,与任务状态独立)。
|
||||
|
||||
## ⚠️ 注意事项
|
||||
|
||||
@@ -190,14 +213,14 @@ bun run tauri dev
|
||||
- 保持分支命名规范
|
||||
|
||||
### AI 配置
|
||||
- 需要有效的 API Key
|
||||
- 需要有效的 API Key(在「设置」中添加 Provider 时录入,前端做 mask 处理防泄露)
|
||||
- 检查网络连接
|
||||
- 关注 Token 使用量
|
||||
- 关注 Token 使用量(对话记录会累计 prompt/completion tokens 落库)
|
||||
|
||||
### 工作流设计
|
||||
- 避免长时间阻塞操作
|
||||
- 设置合理的超时时间
|
||||
- 保留人工干预接口
|
||||
- 设置合理的超时时间(Script 节点可用 `timeout_secs`)
|
||||
- 保留人工干预接口(Human 节点)
|
||||
|
||||
## 🔄 更新日志
|
||||
|
||||
@@ -222,4 +245,4 @@ bun run tauri dev
|
||||
|
||||
---
|
||||
|
||||
**记住**:这不是全流程操作系统,而是专注于本地任务流程的工具。简单、实用、可靠。
|
||||
**记住**:这不是全流程操作系统,而是专注于本地任务流程的工具。简单、实用、可靠。
|
||||
|
||||
Reference in New Issue
Block a user