[docs-scanner] Confusing guidance about shell workload version compatibility
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 90/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- docker
調査の方向性
content/manuals/ai/sandboxes/customize/author/tool-mixins.md を開き、sbx run の例と併せて workload バージョンに関するガイダンスを読んでください。v2 の組み込みショートカットと公開されている v3 のシェル 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日 20時間
- マージ済み PR(30日)
- 131
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
docker/docs のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
docker/docs#26225 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
status/triage
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
docker/docs#26212 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
documentation
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
sync-en
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 2 日以内に返信
-
bug docs
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信