Skip to content

[documentation] Missing documentation for sandbox feature #1978

@docker-agent

Description

@docker-agent

🟡 medium - documentation

File: docs/community/contributing/index.md (line 1)

Code

--sandbox flag in cmd/root/run.go

Problem

The sandbox feature (--sandbox flag) is implemented in the codebase but not documented in the contributing guide or README. Users won't know this feature exists or how to use it. The feature requires Docker Desktop with sandbox support, which is a prerequisite that should be documented.

Suggested Fix

Add a section to the contributing guide or README documenting the sandbox feature, including:

  1. What it does
  2. Prerequisites (Docker Desktop with sandbox support)
  3. How to use it (--sandbox flag)
  4. Example usage
  5. Any limitations or troubleshooting tips

Found by nightly codebase scan

Metadata

Metadata

Assignees

No one assigned

    Labels

    automatedIssues created by cagentkind/documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions