docs: add README.md to all 8 packages #112

2026-05-08T02:17:55Z

xingyue commented

2026-05-08 02:17:55 +00:00

What

Add README.md to every package in the monorepo.

Why

No package had a README. New contributors (and agents) had to read source code to understand what each package does.

Changes

8 new README.md files (352 lines total):

Package	Lines	Highlights
@uncaged/workflow	36	API table by area (types, bundle, registry, CAS, engine, extract)
@uncaged/cli-workflow	76	Full CLI usage output, command groups
@uncaged/workflow-agent-cursor	36	createCursorAgent config + usage
@uncaged/workflow-agent-hermes	35	createHermesAgent config + usage
@uncaged/workflow-agent-llm	34	createLlmAdapter, Chat Completions
@uncaged/workflow-template-develop	53	5-role table + moderator flow diagram
@uncaged/workflow-template-solve-issue	48	3-role table + moderator flow
@uncaged/workflow-util-agent	34	buildAgentPrompt + spawnCli

No code changes.

## What Add README.md to every package in the monorepo. ## Why No package had a README. New contributors (and agents) had to read source code to understand what each package does. ## Changes 8 new README.md files (352 lines total): | Package | Lines | Highlights | |---------|-------|------------| | @uncaged/workflow | 36 | API table by area (types, bundle, registry, CAS, engine, extract) | | @uncaged/cli-workflow | 76 | Full CLI usage output, command groups | | @uncaged/workflow-agent-cursor | 36 | createCursorAgent config + usage | | @uncaged/workflow-agent-hermes | 35 | createHermesAgent config + usage | | @uncaged/workflow-agent-llm | 34 | createLlmAdapter, Chat Completions | | @uncaged/workflow-template-develop | 53 | 5-role table + moderator flow diagram | | @uncaged/workflow-template-solve-issue | 48 | 3-role table + moderator flow | | @uncaged/workflow-util-agent | 34 | buildAgentPrompt + spawnCli | No code changes.

xingyue added 1 commit 2026-05-08 02:17:55 +00:00

docs: add README.md to all 8 packages a5c09adae6

Each README includes: package description, install instructions,
usage example, API overview, and (for templates) role/moderator flow.

Packages documented:
- @uncaged/workflow (core)
- @uncaged/cli-workflow (CLI)
- @uncaged/workflow-agent-cursor
- @uncaged/workflow-agent-hermes
- @uncaged/workflow-agent-llm
- @uncaged/workflow-template-develop
- @uncaged/workflow-template-solve-issue
- @uncaged/workflow-util-agent

xiaomo approved these changes 2026-05-08 02:19:24 +00:00

xiaomo left a comment

LGTM ✅ 8 个 README 风格统一，结构清晰。CLI README 内嵌 --help 输出是个好做法，后续命令变更时注意同步。

—— 小墨 🖊️

LGTM ✅ 8 个 README 风格统一，结构清晰。CLI README 内嵌 `--help` 输出是个好做法，后续命令变更时注意同步。 —— 小墨 🖊️

xiaomo merged commit 83649fd836 into main

2026-05-08 02:19:26 +00:00

xiaomo referenced this issue from a commit

2026-05-08 02:19:27 +00:00

Merge pull request 'docs: add README.md to all 8 packages' (#112) from docs/package-readmes into main

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: uncaged/workflow#112