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 #89

Merged
xiaoju merged 2 commits from docs/88-readme-architecture-cleanup into main 2026-05-08 00:42:17 +00:00
Conversation 1 Commits 2 Files Changed 2
+73 -5
xiaoju commented 2026-05-07 16:10:59 +00:00
Owner
Copy Link
Copy Source

What

Create root README.md and update docs/architecture.md to reflect current monorepo structure.

Why

The repo had no README.md. architecture.md still referenced deleted workflow-role-* packages.

Changes

  • README.md — new: project intro, concepts, packages, quickstart, CLI usage
  • docs/architecture.md — removed workflow-role-* rows, added template packages
  • Cleaned untracked dist/packages/workflow-role-* remnants

Ref

Fixes #88

## What Create root README.md and update docs/architecture.md to reflect current monorepo structure. ## Why The repo had no README.md. architecture.md still referenced deleted `workflow-role-*` packages. ## Changes - **README.md** — new: project intro, concepts, packages, quickstart, CLI usage - **docs/architecture.md** — removed `workflow-role-*` rows, added template packages - Cleaned untracked `dist/packages/workflow-role-*` remnants ## Ref Fixes #88
xiaoju added 1 commit 2026-05-07 16:10:59 +00:00
docs: create README.md, update architecture.md for current structure 4a925b98af 
- Create root README.md with project intro, concepts, packages, quickstart
- Remove workflow-role-* references from docs/architecture.md
- Roles now live inside template packages (src/roles/)
- Clean up untracked dist/packages/workflow-role-* remnants

Fixes #88
xiaoju reviewed 2026-05-07 16:15:01 +00:00
xiaoju left a comment
Author
Owner
Copy Link
Copy Source

Code Review — 小橘 🍊（NEKO Team）

Verdict: Approved with minor nits

✅ Looks Good

  • README.md 结构清晰：概念表 → 包结构 → Quick Start → CLI → Development → Architecture 链接
  • architecture.md 干净移除了 4 行旧 role 包，补上了 develop template
  • CAS 描述准确

⚠️ Minor Issues

  1. CLI Usage 示例用了旧的命令名 — uncaged-workflow list 和 uncaged-workflow threads 已经 deprecated，应该用：

    uncaged-workflow workflow list    # 列出 workflows
uncaged-workflow thread list      # 列出 threads
uncaged-workflow thread show <id> # 查看 thread

  2. Quick Start 里 uncaged-workflow add 也是 deprecated — 应该是 uncaged-workflow workflow add

  3. 没清理 dist/ 残留 — issue 提到 clean dist/packages/workflow-role-* 和更新 .gitignore，但 diff 里没有这部分。可能 dist/ 本来就不在 git 里？

💡 Suggestion

  • README 里 uncaged-workflow skill 可以加一句说明（e.g. "agent-consumable reference docs"）

总体 LGTM，改一下 deprecated 命令就可以合。

## Code Review — 小橘 🍊（NEKO Team） **Verdict:** Approved with minor nits ### ✅ Looks Good - README.md 结构清晰：概念表 → 包结构 → Quick Start → CLI → Development → Architecture 链接 - architecture.md 干净移除了 4 行旧 role 包，补上了 develop template - CAS 描述准确 ### ⚠️ Minor Issues 1. **CLI Usage 示例用了旧的命令名** — `uncaged-workflow list` 和 `uncaged-workflow threads` 已经 deprecated，应该用： ``` uncaged-workflow workflow list # 列出 workflows uncaged-workflow thread list # 列出 threads uncaged-workflow thread show <id> # 查看 thread ``` 2. **Quick Start 里 `uncaged-workflow add` 也是 deprecated** — 应该是 `uncaged-workflow workflow add` 3. **没清理 dist/ 残留** — issue 提到 clean dist/packages/workflow-role-* 和更新 .gitignore，但 diff 里没有这部分。可能 dist/ 本来就不在 git 里？ ### 💡 Suggestion - README 里 `uncaged-workflow skill` 可以加一句说明（e.g. "agent-consumable reference docs"） 总体 LGTM，改一下 deprecated 命令就可以合。
xiaoju added 1 commit 2026-05-07 16:15:35 +00:00
docs: fix deprecated CLI commands in README 7d3954097d 
- workflow add (was: add)
- workflow list (was: list)
- thread list (was: threads)
- thread show (was: thread)

小橘 🍊
xiaoju merged commit a47ed06ea5 into main 2026-05-08 00:42:17 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
xiaoju
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#89
Delete Branch "docs/88-readme-architecture-cleanup"

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?