Repository navigation
[DRAFT] Add docs for cloud machine simulation (hold until release) - #5427
Draft
Jeremy Rose (jeremyrose-viam) wants to merge 7 commits into
Draft
Jeremy Rose (jeremyrose-viam) wants to merge 7 commits into
Jeremy Rose (jeremyrose-viam) wants to merge 7 commits into
Conversation
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>
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

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
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.read_simulationas Read-only,start_simulationas Write,stop_simulationas 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:
Sources consulted
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-prodcompletes.🤖 Generated with Claude Code