uncaged/nerve
Archived
10
0
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: 以代码为准重写全部文档 #95

New Issue
Closed
opened 2026-04-24 15:42:00 +00:00 by xiaoju · 0 comments
xiaoju commented 2026-04-24 15:42:00 +00:00
Owner
Copy Link
Copy Source

背景

文档与代码实际行为存在偏差，需要以代码为准重写全部文档。

需要修改的文件

1. README.md — 根文档

问题：

  • Configuration 示例中有 kind: workflow reflex（第 89-91 行），但代码已在 config.ts:130-136 明确拒绝 YAML 中的 workflow reflex
  • Workflow 只能通过 Sense compute 返回值的 workflow 字段触发（name|maxRounds|prompt 格式）
  • 缺少 @uncaged/nerve-store 包的说明
  • Architecture 图缺少 Daemon IPC 和 File Watcher

修改：

  • 删除 kind: workflow reflex 示例，替换为 Sense compute 触发 Workflow 的说明
  • Packages 表格加上 @uncaged/nerve-store
  • Architecture 图加上 Daemon IPC、File Watcher
  • Core Concepts 表格中 Reflex 的描述更新：Reflex 只调度 Sense，不直接触发 Workflow

2. packages/core/README.md

问题：

  • 缺少对 Sense-Workflow Directive（parseSenseWorkflowDirective、routeSenseComputeOutput）的说明
  • 缺少 Daemon IPC Protocol 类型的说明
  • 缺少 START/END 常量和 Workflow Automaton 类型的说明

修改：

  • What's Inside 加上 Sense-Workflow Directive、Daemon IPC Protocol、Workflow Automaton types
  • 加入 Sense 触发 Workflow 的示例代码

3. packages/daemon/README.md

问题：

  • 缺少 worker-pool、kernel-sense-groups、kernel-file-watch 等模块
  • 缺少 crash recovery 和 thread resume 的说明
  • createKernel 示例缺少实际需要的参数

修改：

  • Architecture 表格补全所有模块
  • 加入 Crash Recovery 说明（crash backoff、thread resume）
  • 修正 createKernel 用法示例

4. packages/cli/README.md

问题：

  • 缺少 nerve workflow trigger 命令（通过 Daemon IPC trigger-workflow）

修改：

  • 检查并补全所有 CLI 命令
  • 确认命令描述与实际行为一致

5. 新建 packages/store/README.md

当前状态： 不存在

内容：

  • LogStore：append-only 结构化日志、WAL-mode SQLite、workflow run tracking、thread message 存储
  • LogArchive：JSONL 冷归档
  • BlobStore：CAS（Content-Addressable Storage）二进制存储
  • WorkflowRunStatus 状态机：queued → started → completed/failed/crashed/interrupted

原则

  • 以代码为准，不要编造代码中不存在的功能
  • 文档风格保持现有的简洁 Markdown 表格 + 代码示例风格
  • 所有示例必须能在当前代码上跑通

小橘 🍊（NEKO Team）

## 背景 文档与代码实际行为存在偏差，需要以代码为准重写全部文档。 ## 需要修改的文件 ### 1. `README.md` — 根文档 **问题：** - Configuration 示例中有 `kind: workflow` reflex（第 89-91 行），但代码已在 `config.ts:130-136` **明确拒绝** YAML 中的 workflow reflex - Workflow 只能通过 Sense compute 返回值的 `workflow` 字段触发（`name|maxRounds|prompt` 格式） - 缺少 `@uncaged/nerve-store` 包的说明 - Architecture 图缺少 Daemon IPC 和 File Watcher **修改：** - 删除 `kind: workflow` reflex 示例，替换为 Sense compute 触发 Workflow 的说明 - Packages 表格加上 `@uncaged/nerve-store` - Architecture 图加上 Daemon IPC、File Watcher - Core Concepts 表格中 Reflex 的描述更新：Reflex 只调度 Sense，不直接触发 Workflow ### 2. `packages/core/README.md` **问题：** - 缺少对 Sense-Workflow Directive（`parseSenseWorkflowDirective`、`routeSenseComputeOutput`）的说明 - 缺少 Daemon IPC Protocol 类型的说明 - 缺少 `START`/`END` 常量和 Workflow Automaton 类型的说明 **修改：** - What's Inside 加上 Sense-Workflow Directive、Daemon IPC Protocol、Workflow Automaton types - 加入 Sense 触发 Workflow 的示例代码 ### 3. `packages/daemon/README.md` **问题：** - 缺少 worker-pool、kernel-sense-groups、kernel-file-watch 等模块 - 缺少 crash recovery 和 thread resume 的说明 - `createKernel` 示例缺少实际需要的参数 **修改：** - Architecture 表格补全所有模块 - 加入 Crash Recovery 说明（crash backoff、thread resume） - 修正 `createKernel` 用法示例 ### 4. `packages/cli/README.md` **问题：** - 缺少 `nerve workflow trigger` 命令（通过 Daemon IPC trigger-workflow） **修改：** - 检查并补全所有 CLI 命令 - 确认命令描述与实际行为一致 ### 5. 新建 `packages/store/README.md` **当前状态：** 不存在 **内容：** - LogStore：append-only 结构化日志、WAL-mode SQLite、workflow run tracking、thread message 存储 - LogArchive：JSONL 冷归档 - BlobStore：CAS（Content-Addressable Storage）二进制存储 - WorkflowRunStatus 状态机：queued → started → completed/failed/crashed/interrupted ## 原则 - **以代码为准**，不要编造代码中不存在的功能 - 文档风格保持现有的简洁 Markdown 表格 + 代码示例风格 - 所有示例必须能在当前代码上跑通 --- 小橘 🍊（NEKO Team）
This repo is archived. You cannot comment on issues.
No Branch/Tag Specified
Branches Tags
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
aobing jiashuang (Jia Shuang) jiayi (Jiayi) luming scottwei tuanzi xiaoju xiaomo xiaonuo xingyue
No Assignees
1 Participants
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: uncaged/nerve#95
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?