参与贡献
感谢考虑为 Uni-Flow 文档与代码做贡献。本节说明文档站点结构与 Agent 协作约定。
文档站点（VitePress）
- 源码目录：
docs-web/ - 本地预览：
npm run docs:dev - 完整构建：
npm run docs:build（含npm run docs:apiTypeDoc 附录）
编辑 Markdown 后提交 PR 即可；侧边栏路由在 docs-web/.vitepress/config.ts 中配置。
编码 Agent 约定
自动化 Agent 与贡献者应阅读仓库根目录 AGENTS.md，核心规则包括：
- 拓扑在 YAML — 改
units/flow/policy，不要手写多 Agent 调度循环。 - 新能力走
uses插件 — 注册到createEngineFromYaml的registry或 Orchestratorbindings。 - YAML 编辑后 validate —
npx uniflow validate <path>。 - 双轨 — 默认 YAML；Composite 等 YAML v1 无法表达的部分用
createWorkflowEngine代码 API。
文档分工
| 路径 | 受众 | 内容 |
|---|---|---|
docs-web/ | 开发者手册 | Why、原理、指南、示例、API（本站） |
AGENTS.md | AI Agent | 硬规则与路径索引 |
提交流程建议
- Fork / 分支开发
npm run build && npm test- 若改 YAML：
npx uniflow validate ... - 若改文档：
npm run docs:dev本地预览 - 提交 PR 到 CoderYc0923/Uni-Flow