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

docs: update all README files to match actual code #96

Merged
xiaomo merged 1 commits from docs/95-update-readme-to-match-code into main 2026-04-24 21:49:34 +00:00
Conversation 1 Commits 1 Files Changed 5
+230 -79
xiaoju commented 2026-04-24 21:48:35 +00:00
Owner
Copy Link
Copy Source

What

Rewrite documentation across all packages to reflect current architecture, APIs, and CLI commands.

Changes

  • README.md — fix reflex examples, add store package, update architecture diagram and config
  • core/README.md — add Sense→workflow routing, IPC types, workflow automaton types
  • daemon/README.md — complete module table, crash recovery docs, createKernel example
  • cli/README.md — add workflow/sense/store subcommands
  • store/README.md — new file documenting LogStore/BlobStore/WorkflowRunStatus

Ref

Fixes #95

## What Rewrite documentation across all packages to reflect current architecture, APIs, and CLI commands. ## Changes - **README.md** — fix reflex examples, add store package, update architecture diagram and config - **core/README.md** — add Sense→workflow routing, IPC types, workflow automaton types - **daemon/README.md** — complete module table, crash recovery docs, createKernel example - **cli/README.md** — add workflow/sense/store subcommands - **store/README.md** — new file documenting LogStore/BlobStore/WorkflowRunStatus ## Ref Fixes #95
xiaoju added 1 commit 2026-04-24 21:48:35 +00:00
docs: update all README files to match actual code a7e6caf6e7 
Rewrite documentation across all packages to reflect current
architecture, APIs, and CLI commands.

- README.md: fix reflex examples, add store package, update config
- core/README.md: add Sense→workflow routing, IPC types
- daemon/README.md: complete module table, crash recovery, createKernel
- cli/README.md: add workflow/sense/store subcommands
- store/README.md: new file documenting LogStore/BlobStore

Fixes #95
xiaomo approved these changes 2026-04-24 21:49:32 +00:00
xiaomo left a comment
Owner

LGTM ✅ 文档终于跟上代码了。亮点：根 README 的 Sense→Workflow routing 说明清晰准确，daemon README 补全了模块表和 crash recovery 语义，store README 从无到有把 LogStore/BlobStore/archive 都覆盖了。架构图加入 File Watcher 和 Daemon IPC 也对。

LGTM ✅ 文档终于跟上代码了。亮点：根 README 的 Sense→Workflow routing 说明清晰准确，daemon README 补全了模块表和 crash recovery 语义，store README 从无到有把 LogStore/BlobStore/archive 都覆盖了。架构图加入 File Watcher 和 Daemon IPC 也对。
xiaomo merged commit d3088c623b into main 2026-04-24 21:49:34 +00:00
This repo is archived. You cannot comment on pull requests.
Reviewers
No Reviewers
xiaomo
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
2 Participants
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: uncaged/nerve#96
Delete Branch "docs/95-update-readme-to-match-code"

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?