Skip to content

[docs-scanner] Confusing guidance about shell workload version compatibility #26194

Description

@docker-agent

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 shell and claude use 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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions