uncaged/workflow
10
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: create README.md + update architecture.md for current structure #88

New Issue
Closed
opened 2026-05-07 16:04:38 +00:00 by xiaoju · 0 comments
xiaoju commented 2026-05-07 16:04:38 +00:00
Owner
Copy Link
Copy Source

背景

仓库没有 README.md。docs/architecture.md 还引用已删除的 workflow-role-* 包。dist/ 有旧 role 包的残留物。

需要做的

1. 创建根 README.md

内容应包括：

  • 项目一句话介绍（workflow engine that executes single-file ESM bundles）
  • 核心概念表（Workflow, Bundle, Thread, CAS, Registry）— 可从 uncaged-workflow skill cli 输出获取
  • 当前 monorepo 包结构（只列现有包，不要列已删除的 role 包）：
    • packages/workflow — core lib
    • packages/cli-workflow — CLI
    • packages/workflow-template-develop — develop workflow template (includes roles)
    • packages/workflow-template-solve-issue — solve-issue workflow template (includes roles)
    • packages/workflow-agent-hermes — Hermes agent adapter
    • packages/workflow-agent-cursor — Cursor agent adapter
    • packages/workflow-agent-llm — LLM agent adapter
    • packages/workflow-util-agent — agent utilities
  • Quick start（install, add workflow, run）
  • CLI 用法概览（指向 uncaged-workflow help 和 uncaged-workflow skill）

2. 更新 docs/architecture.md

  • 移除所有 workflow-role-* 包的引用
  • 更新包结构表：role 现在在 template 包的 src/roles/ 下
  • 确保其他文档引用一致

3. 清理 dist/ 残留

rm -rf dist/packages/workflow-role-*

加入 .gitignore 如果 dist/ 不应跟踪。

4. 各包的 README.md（可选）

如果某个包有 README，确保内容跟当前代码一致。没有的话不用创建（根 README 够了）。

小橘 🍊（NEKO Team）

## 背景 仓库没有 README.md。`docs/architecture.md` 还引用已删除的 `workflow-role-*` 包。`dist/` 有旧 role 包的残留物。 ## 需要做的 ### 1. 创建根 README.md 内容应包括： - 项目一句话介绍（workflow engine that executes single-file ESM bundles） - 核心概念表（Workflow, Bundle, Thread, CAS, Registry）— 可从 `uncaged-workflow skill cli` 输出获取 - 当前 monorepo 包结构（只列现有包，不要列已删除的 role 包）： - `packages/workflow` — core lib - `packages/cli-workflow` — CLI - `packages/workflow-template-develop` — develop workflow template (includes roles) - `packages/workflow-template-solve-issue` — solve-issue workflow template (includes roles) - `packages/workflow-agent-hermes` — Hermes agent adapter - `packages/workflow-agent-cursor` — Cursor agent adapter - `packages/workflow-agent-llm` — LLM agent adapter - `packages/workflow-util-agent` — agent utilities - Quick start（install, add workflow, run） - CLI 用法概览（指向 `uncaged-workflow help` 和 `uncaged-workflow skill`） ### 2. 更新 docs/architecture.md - 移除所有 `workflow-role-*` 包的引用 - 更新包结构表：role 现在在 template 包的 `src/roles/` 下 - 确保其他文档引用一致 ### 3. 清理 dist/ 残留 ```bash rm -rf dist/packages/workflow-role-* ``` 加入 .gitignore 如果 dist/ 不应跟踪。 ### 4. 各包的 README.md（可选） 如果某个包有 README，确保内容跟当前代码一致。没有的话不用创建（根 README 够了）。 --- 小橘 🍊（NEKO Team）
Sign in to join this conversation.
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
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: uncaged/workflow#88
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?