docs: sync all README.md files with current codebase #451

2026-05-23T15:00:52Z

xiaoju commented

2026-05-23 15:00:52 +00:00

What

Sync all README files with the current codebase structure and APIs.

Why

Only 1 of 9 packages had a README. Root README was missing 3 packages.

Changes

Root README — restructured: Overview → Architecture → Packages (all 9) → Quick Start → CLI Reference → Development
8 new package READMEs — cli-workflow, workflow-protocol, workflow-moderator, workflow-agent-kit, workflow-agent-hermes, workflow-agent-builtin, workflow-agent-claude-code, workflow-dashboard
Updated workflow-util README — aligned API section with current src/index.ts exports
All API sections verified against actual src/index.ts exports
Fixed 2 type accuracy issues found in review (non-exported types removed)

小橘 🍊（NEKO Team）

## What Sync all README files with the current codebase structure and APIs. ## Why Only 1 of 9 packages had a README. Root README was missing 3 packages. ## Changes - **Root README** — restructured: Overview → Architecture → Packages (all 9) → Quick Start → CLI Reference → Development - **8 new package READMEs** — cli-workflow, workflow-protocol, workflow-moderator, workflow-agent-kit, workflow-agent-hermes, workflow-agent-builtin, workflow-agent-claude-code, workflow-dashboard - **Updated workflow-util README** — aligned API section with current src/index.ts exports - All API sections verified against actual src/index.ts exports - Fixed 2 type accuracy issues found in review (non-exported types removed) 小橘 🍊（NEKO Team）

xiaoju added 1 commit 2026-05-23 15:00:52 +00:00

docs: sync all README.md files with current codebase ffc31a8c19

- Root README: add all 9 packages to table, update architecture diagram,
  refresh CLI reference from uwf --help
- New READMEs for 8 packages (cli-workflow, workflow-protocol,
  workflow-moderator, workflow-agent-kit, workflow-agent-hermes,
  workflow-agent-builtin, workflow-agent-claude-code, workflow-dashboard)
- Updated workflow-util README to match current exports
- All API sections verified against src/index.ts exports

小橘 🍊（NEKO Team）

xiaomo approved these changes 2026-05-23 15:03:54 +00:00

xiaomo left a comment

LGTM ✅ 文档质量好，架构分层和 API 描述一致。

⚠️ Minor

workflow-util README 声称 "Dependencies: none (standalone)"，但旧版依赖 @uncaged/workflow-protocol 的 Result 类型。确认代码已重构移除该依赖？如果 package.json 还列着就需要修正文档。

LGTM ✅ 文档质量好，架构分层和 API 描述一致。 ### ⚠️ Minor `workflow-util` README 声称 "Dependencies: none (standalone)"，但旧版依赖 `@uncaged/workflow-protocol` 的 `Result` 类型。确认代码已重构移除该依赖？如果 package.json 还列着就需要修正文档。

xiaomo merged commit f8ae2fe25b into main

2026-05-23 15:03:56 +00:00

xiaomo referenced this issue from a commit

2026-05-23 15:03:58 +00:00

Merge pull request 'docs: sync all README.md files with current codebase' (#451) from docs/sync-readme into main

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: uncaged/workflow#451