[docs-scanner] Confusing guidance about shell workload version compatibility
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1 小时以内
- 新手友好度
- 90/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- docker
调研方向
打开 content/manuals/ai/sandboxes/customize/author/tool-mixins.md,并结合 sbx run 示例阅读 workload 版本指导。明确 v2 内置快捷方式与已发布的 v3 shell workload 之间的区别,然后验证措辞是否始终一致地说明支持哪种组合。
由索引模型根据 Issue 内容生成。
描述
File: content/manuals/ai/sandboxes/customize/author/tool-mixins.md
Issue
The tutorial states that built-in shortcuts including shell use v2:
"Use a v3 workload with this mixin. Built-in shortcuts such as
shellandclaudeuse v2."
However, the tutorial then immediately uses docker.io/docker/sbx-kit-shell:1.0.0 with the v3 mixin successfully:
$ sbx run docker.io/docker/sbx-kit-shell:1.0.0 --name claude-mixin-test \
--kit ./claude-mixin
Why this matters
A reader following this tutorial might be confused about whether they can actually use the shell workload with v3 mixins. The statement warns against using shell because it's v2, but then the example uses what appears to be a shell workload. The distinction between the shortcut shell and the full image reference docker.io/docker/sbx-kit-shell:1.0.0 is not explained, leaving readers uncertain whether this combination is actually supported.
Suggested fix
Clarify the distinction between built-in shortcuts (like shell without a registry reference) and published v3 workloads. For example:
"Use a v3 workload with this mixin. Built-in shortcuts such as shell and claude (used without a full image reference) use v2 and can't be combined with v3 mixins. However, Docker provides published v3 workloads like docker.io/docker/sbx-kit-shell:1.0.0 that work with v3 mixins."
Found by nightly documentation quality scanner
- 主要语言
- Markdown
- 星标
- 4.7k
- 派生
- 8.5k
- 平均合并
- 1 天 21 小时
- 30 天内合并 PR
- 111
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
docker/docs 的其他 Issue
-
Instructions no longer valid可能已有人在做 @aevesdocker 于 3 天前认领。 未关闭status/triage
难度 1/5 1 小时以内 新手友好度 85/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 85/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 90/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 95/100
维护者通常 1 天内回复
相似的 Issue
-
area:docs area:render bug criticality:p3 triage:needs-implementation
难度 2/5 1-3 小时 新手友好度 78/100
registrystack/registry-stack#1618 ·
维护者通常 1 天内回复
-
curriculum documentation quality
难度 2/5 1-3 小时 新手友好度 78/100
githubnext/gh-aw-workshop#3897 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 76/100
siderolabs/docs#791 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 75/100
nestjs/docs.nestjs.com#3554 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 98/100
huggingface/course#1320 ·
维护者通常 1 天内回复