docs(ios-runner): RUNNER_PROTOCOL.md points at the wrong file and omits recovery and busy codes
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 75/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- swift, typescript
调研方向
要更新的文件是 apple/runner/RUNNER_PROTOCOL.md。首先,在 packages/platform-apple/src/runner/runner-contract.ts:53-94 中验证当前命令名称的位置。然后,检查用于恢复和错误代码的链接文件:runner/runner-command-recovery.ts、AgentDeviceRunnerUITests/RunnerTests+Transport.swift 和 RunnerTests+CommandJournal.swift。使用正确的引用和简要说明更新文档,并通过 git grep 确保所有符号都存在。最后,运行 pnpm check:agent-guidance 以确认更改通过。
由索引模型根据 Issue 内容生成。
描述
Purpose
apple/runner/RUNNER_PROTOCOL.md:67 says the command names live in runner-client.ts. They are in packages/platform-apple/src/runner/runner-contract.ts:53-94. The doc also doesn't mention:
commandIdandstatusrecovery (the command journal)runnerFatalandrunnerMainThreadBusy- the error codes
RUNNER_BUSY,RUNNER_WEDGEDandMAIN_THREAD_TIMEOUT
Line references are at 01328de411.
Required behavior
- Fix the pointer.
- Add a short section for each missing concept: when it is produced, what it means, and what the daemon does with it. Link to the declaration sites (
runner-contract.ts,runner/runner-command-recovery.ts,apple/runner/AgentDeviceRunner/AgentDeviceRunnerUITests/RunnerTests+Transport.swift,RunnerTests+CommandJournal.swift) and don't copy tables.
Completion conditions
- Every symbol the doc names exists: check with
git grep. pnpm check:agent-guidanceis green, if the doc is part of that check.
- 主要语言
- TypeScript
- 星标
- 4.7k
- 派生
- 304
- 平均合并
- 11 小时 29 分钟
- 30 天内合并 PR
- 514
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
callstack/agent-device 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
callstack/agent-device#1869 ·
-
needs-triage
难度 5/5 一周以上 新手友好度 32/100
callstack/agent-device#2948 ·
-
难度 4/5 3-5 天 新手友好度 55/100
callstack/agent-device#2946 ·
-
needs-triage
难度 4/5 3-5 天 新手友好度 45/100
callstack/agent-device#2940 ·
-
bug ready-for-agent
难度 5/5 一周以上 新手友好度 35/100
callstack/agent-device#2935 ·
查看 callstack/agent-device 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
bcgov/bc-wallet-mobile#4761 · 1 条评论 ·
-
external-issue to-triage
难度 2/5 1-3 小时 新手友好度 88/100
-
area-deployment area-integrations triage:bot-seen
难度 2/5 半天 新手友好度 86/100
-
难度 2/5 1-3 小时 新手友好度 82/100
-
refactor
难度 2/5 1-3 小时 新手友好度 84/100