Skip to content

[DRAFT] Add docs for cloud machine simulation (hold until release) - #5427

Draft
Jeremy Rose (jeremyrose-viam) wants to merge 7 commits into
viamrobotics:mainfrom
jeremyrose-viam:worktree-sim-docs-draft
Draft

Jeremy Rose (jeremyrose-viam) wants to merge 7 commits into
viamrobotics:mainfrom
jeremyrose-viam:worktree-sim-docs-draft

Conversation

@jeremyrose-viam

Copy link
Copy Markdown
Member

HOLD: do not merge until the features ship

These docs describe features that are not released yet: the setup wizard's cloud simulation option, and the simulation tools in the Config AI assistant and the Viam MCP server. Please hold this PR until they are released.

Everything here should be reviewed again, closely, against the released behavior. The drafts were written from pre-release code and PR descriptions, and any of it can change before launch. Draft-only notes are left as TODO(draft) comments in the source.

What this changes

  • New page, set-up-a-machine/simulate-a-machine.md: what a cloud simulation is, what to know before starting (billing, idle timeout, stopping and restarting, modules that need hardware), how to start one, how to check on, stop, or restart it, and how to manage simulations from the AI assistant or MCP.
  • set-up-a-machine/first-machine.md: a pointer to the simulation option in the setup wizard step, and a short definition of machine and part (wording taken from "What is Viam?") for readers who go straight to the setup page.
  • set-up-a-machine/with-cli.md: one sentence in "Get the part ID" saying what a part is.
  • MCP server: three rows in the tools table (read_simulation as Read-only, start_simulation as Write, stop_simulation as Write (destructive)) and a short paragraph on the MCP page. The table is hand-maintained.

The machine and part definition edits are in their own commit, so they can ship ahead of the simulation docs if needed.

Open items that need answers from other teams

These probably can't be settled from code:

  1. Pricing and billing: the per-minute rate, or whether to link to a pricing page instead of stating it. The docs currently assume simulation is billed to the user who starts or authorizes it, including through the AI assistant or MCP; please confirm.
  2. Naming: the user-facing name. The wizard says "simulated environment"; the MCP tool descriptions say Isaac Sim.
  3. Launch state: whether the simulation option is behind a feature flag at launch, and where it appears in the wizard relative to the "separate board/computer" question.
  4. Idle timeout: what counts as "actuating" for the "at most 60 minutes" timeout, and whether the limit is fixed.
  5. Startup: typical time to start, and what the wizard shows if a simulation fails to start.
  6. Built-in fake models: whether built-in fake components (for example, the fake arm) work in the simulated environment, so the page can point to them.

Sources consulted

  • Pre-release code and pull request descriptions for the setup wizard and for the AI assistant and MCP simulation tools.
  • The existing "What is Viam?" page, for the machine and part wording.

I did not run the feature or see the live UI, so the pages describe behavior from code and PR descriptions only.

Checks

Prettier 3.2.5, markdownlint, and vale (3.16.0 locally; CI pins 3.12.0) pass on the changed docs files, and make build-prod completes.

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@netlify

netlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for viam-docs ready!

Name Link
🔨 Latest commit 06622e5
🔍 Latest deploy log https://app.netlify.com/projects/viam-docs/deploys/6ad184045f392aef360d3ce7
😎 Deploy Preview https://deploy-preview-5427--viam-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 40 (🟢 up 5 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@viambot viambot added the safe to build This pull request is marked safe to build from a trusted zone label Oct 16, 2026
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

This branch has not been deployed

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

Labels

safe to build This pull request is marked safe to build from a trusted zone

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants