Skip to main content
Create or update docs/en/user_guide/modules/environments/<environment-id>.mdx and its localized counterpart.

​
Required Content

Document:
  • Whether the provider is local or remote and which operating systems can control it.
  • Official setup links, authentication, account scope, quotas, and external prerequisites.
  • Image, snapshot, named-image, template, workspace, and persistence behavior.
  • Every public parameter with type, default, unit, valid values, and selection guidance.
  • CPU, memory, disk, GPU, placement, and unsupported resource controls.
  • Setup, operation, idle, lifetime, command, and deletion timeout semantics.
  • Supported network modes, allowlist entry types, phase switching, and limitations.
  • Provider-open limits and practical concurrency guidance.
  • A minimal runnable command and provider-specific examples.
  • Common authentication, image, permission, quota, timeout, network, and cleanup errors.

​
Explain Inferred and Explicit Values

Clearly separate fields users pass directly from values a recipe infers. Show custom image or provider-native selector overrides when supported and state their precedence. Link to Network Policy for run configuration, Sandbox Resource Limits for cross-provider units and capacity planning, and agentcompass run for concurrency and retry behavior. Keep benchmark-specific image names and evaluator rules on benchmark pages.

​
Preview and Validate

Add new pages to docs/docs.json, preview both normal and narrow layouts, and validate: