[docs-scanner] Sandboxes API tutorial mentions client.get() without showing how to use it
维护者通常 1 天内回复
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 88/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- typescript
调研方向
从 content/manuals/ai/sandboxes-api/get-started.md 开始，检查现有的 client.kits.launchAndWait() 和 sandbox.delete() 示例。为 client.get(name) 添加一个简短的恢复示例，或链接到 cookbook/find-a-process-you-lost-track-of.md，并提供具体的恢复指导。当首次阅读的读者能够识别 sandbox 名称、检索它并完成清理时，即视为完成。
由索引模型根据 Issue 内容生成。
描述
File: content/manuals/ai/sandboxes-api/get-started.md
Issue
The tutorial tells readers what to do if the program stops unexpectedly, but doesn't show them how:
If the program stops after printing the sandbox name, retrieve the sandbox with
client.get(name)and delete it when you're finished.
This is the only mention of client.get() in the tutorial, and there's no example of how to use it. The tutorial shows client.kits.launchAndWait() and sandbox.delete(), but never demonstrates retrieval.
Why this matters
A reader following the tutorial who encounters this failure scenario won't know:
- What to import or how to call
client.get(name) - What the
nameparameter should be (the fullsandboxes/<uid>string?) - What to do with the returned object
- Whether they need to check the sandbox state before deleting
The tutorial is aimed at first-time users ("Run your first cloud sandbox"), so they can't be expected to infer the API from this brief mention.
Suggested fix
Add a brief code example showing recovery, either inline or in a collapsed section:
// If the program stopped, retrieve and clean up:
const existing = await client.get('sandboxes/<uid>');
const latest = await existing.refresh();
await latest.delete({ force: true });
Or reference the cookbook with a specific example: "See Find a process you lost track of for recovery steps."
Found by nightly documentation quality scanner
- 主要语言
- Markdown
- 星标
- 4.7k
- 派生
- 8.5k
- 平均合并
- 1 天 15 小时
- 30 天内合并 PR
- 117
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
docker/docs 的其他 Issue
-
status/triage
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复
-
[docs-scanner] Container proxy table misleadingly presents nested properties as separate parameters可能已有人在做 @dave123981 于 8 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 1 天内回复
-
[docs-scanner] Conflicting WSL version requirements between ECI pages可能已有人在做 @dave123981 于 9 天前认领。 未关闭
难度 1/5 1-3 小时 新手友好度 90/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
[docs-scanner] Ambiguous version qualifier for MSI all-users installation requirement可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 1/5 1 小时以内 新手友好度 92/100
维护者通常 1 天内回复
相似的 Issue
-
难度 1/5 1-3 小时 新手友好度 87/100
adri0/scadustats#128 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 84/100
WordPress/hosting-handbook#506 ·
维护者通常 2 天内回复
-
Docs: refresh target-app-parity and file-format-parity against main可能已有人在做 @vangel76 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 70/100
storytold/photocraft#4417 · 1 条评论 ·
维护者通常 1 天内回复
-
documentation help wanted needs-triage
难度 1/5 1-3 小时 新手友好度 75/100
hivecommons/hive#11606 · 2 条评论 ·
维护者通常 1 天内回复
-
documentation good first issue launch
难度 2/5 1-3 小时 新手友好度 83/100
FlologixAI/etchwork#4 ·