docs: add agent API reference, onboarding guide, and universal skill

- docs/agent-api-reference.md (473 lines): complete HTTP API reference for all 12 endpoints
- docs/agent-onboarding-guide.md (272 lines): ssh_cli and http_pull workflows, Forgejo integration
- skill/SKILL.md (281 lines): universal agent skill, platform-agnostic, curl-based examples

All content in English. No code changes.
This commit is contained in:
Zer4tul 2026-05-12 14:57:05 +08:00
parent e39a16498c
commit d1a746a8cb
9 changed files with 1250 additions and 0 deletions

View file

@ -0,0 +1,36 @@
## 1. API 参考文档
- [ ] 1.1 创建 `docs/agent-api-reference.md`
- [ ] 1.2 列出所有公开端点(~12 个每个包含HTTP 方法、URL、请求体、响应体、错误码、curl 示例
- [ ] 1.3 认证部分http_pull token、webhook HMAC-SHA256 签名
- [ ] 1.4 错误码汇总401/403/404/400/500每个附触发场景
- [ ] 1.5 通用说明base_url、Content-Type、字符编码、分页如有
## 2. Agent 接入指南
- [ ] 2.1 创建 `docs/agent-onboarding-guide.md`
- [ ] 2.2 两种执行模式对比表ssh_cli vs http_pull
- [ ] 2.3 ssh_cli 模式完整工作流:配置 host → CLI 安装 → 自动调度 → PR 工作流
- [ ] 2.4 http_pull 模式完整工作流register → heartbeat → dequeue → execute → complete/receipt
- [ ] 2.5 Forgejo 集成说明Issue → Task、分支命名、PR 生命周期
- [ ] 2.6 结构化 prompt 格式说明ssh_cli 模式下 Agent 收到的 prompt 结构)
- [ ] 2.7 常见问题 FAQ
## 3. 通用 Agent Skill
- [ ] 3.1 创建 `skill/SKILL.md`YAML frontmatter + Markdown body
- [ ] 3.2 Quick Start最简接入示例3 步以内)
- [ ] 3.3 Instructions详细 API 调用流程register → heartbeat → dequeue → execute → complete
- [ ] 3.4 Examples每种操作的 curl 示例
- [ ] 3.5 Guidelines错误处理、重试策略、认证规则
- [ ] 3.6 执行模式选择指南Agent 如何判断自己用 ssh_cli 还是 http_pull
- [ ] 3.7 Forgejo 工作流说明分支命名、PR 创建、webhook 触发)
- [ ] 3.8 验证Skill 内容与 API 参考文档一致、curl 示例可执行
## 4. 验证
- [ ] 4.1 API 参考文档覆盖所有已实现端点
- [ ] 4.2 curl 示例基于 arm0 实例可执行
- [ ] 4.3 Skill 格式符合标准规范YAML frontmatter + Markdown body
- [ ] 4.4 Skill 不包含任何平台特定语法
- [ ] 4.5 接入指南与当前代码实现一致