Add documentation for Cloud API, tutorials, and sandbox concepts#2007
Open
r33drichards wants to merge 2 commits into
Open
Add documentation for Cloud API, tutorials, and sandbox concepts#2007r33drichards wants to merge 2 commits into
r33drichards wants to merge 2 commits into
Conversation
…PI reference Scaffold the "SBX Docs" outline into the existing Diátaxis structure: - Concepts -> explanation/sandbox/ : images, pools, claims, autoscaling, services - How To -> how-to-guides/sandbox/ : build-a-linux-image, build-a-windows-image, connect-to-a-service, use-the-sdk - Tutorials -> tutorials/ : Hermes + Cua Driver, surf the web, MCP-sampling sub-agent, Cua Bench benchmark, RL a model - Reference -> reference/cloud-api/ : CUA Cloud REST API stub (generated from OpenAPI) Each page has title/description frontmatter and an outline; all are wired into the section meta.json nav and linked from the relevant index pages. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014tuBJpDJU8UCR4UQSrLkxg
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughAdds documentation pages across the Explanation (sandbox images, pools, claims, autoscaling, services), How-to Guides (build Linux/Windows images, connect to a service, use SDK), Reference (Cloud REST API stub), and Tutorials (five new pages) sections, with navigation metadata updated throughout. ChangesSandbox Documentation Expansion
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/content/docs/explanation/index.mdx (1)
8-8: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low valueApply LanguageTool style suggestion to reduce word repetition.
The words "explanation" and "explains" are similar (verb and noun from the same root). Consider rewording to improve clarity and avoid the redundancy.
Example revision: "The Sandbox section provides deeper insight into..."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/content/docs/explanation/index.mdx` at line 8, The text contains redundant word choices where "explanation" appears in the link path followed immediately by "explains" in the sentence. To fix this, replace the verb "explains" with alternative verbs such as "describes", "covers", "outlines", or "provides insight into" to eliminate the repetition of words derived from the same root. Review the entire section for similar instances of this pattern and apply consistent rewording throughout to improve clarity and readability.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/content/docs/explanation/index.mdx`:
- Line 8: The text contains redundant word choices where "explanation" appears
in the link path followed immediately by "explains" in the sentence. To fix
this, replace the verb "explains" with alternative verbs such as "describes",
"covers", "outlines", or "provides insight into" to eliminate the repetition of
words derived from the same root. Review the entire section for similar
instances of this pattern and apply consistent rewording throughout to improve
clarity and readability.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f70ae337-a919-4197-b9cd-d279466a4b4c
📒 Files selected for processing (24)
docs/content/docs/explanation/index.mdxdocs/content/docs/explanation/meta.jsondocs/content/docs/explanation/sandbox/autoscaling.mdxdocs/content/docs/explanation/sandbox/claims.mdxdocs/content/docs/explanation/sandbox/images.mdxdocs/content/docs/explanation/sandbox/meta.jsondocs/content/docs/explanation/sandbox/pools.mdxdocs/content/docs/explanation/sandbox/services.mdxdocs/content/docs/how-to-guides/sandbox/build-a-linux-image.mdxdocs/content/docs/how-to-guides/sandbox/build-a-windows-image.mdxdocs/content/docs/how-to-guides/sandbox/connect-to-a-service.mdxdocs/content/docs/how-to-guides/sandbox/meta.jsondocs/content/docs/how-to-guides/sandbox/use-the-sdk.mdxdocs/content/docs/reference/cloud-api/index.mdxdocs/content/docs/reference/cloud-api/meta.jsondocs/content/docs/reference/index.mdxdocs/content/docs/reference/meta.jsondocs/content/docs/tutorials/benchmark-with-cua-bench.mdxdocs/content/docs/tutorials/index.mdxdocs/content/docs/tutorials/meta.jsondocs/content/docs/tutorials/rl-a-model-for-computer-use.mdxdocs/content/docs/tutorials/sandbox-for-hermes-and-cua-driver.mdxdocs/content/docs/tutorials/sandbox-to-surf-the-web.mdxdocs/content/docs/tutorials/sub-agent-with-mcp-sampling.mdx
Change "explains" to "lays out" in the Explanation index so the verb does not echo the "explanation" link paths in the same paragraph (CodeRabbit nit). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014tuBJpDJU8UCR4UQSrLkxg
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
2 participants
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.
Summary
This PR significantly expands the Cua documentation by adding comprehensive guides for the Cloud REST API, new tutorials for computer-use tasks, how-to guides for sandbox image building and service connectivity, and explanation pages covering sandbox architecture concepts.
Key Changes
New Reference Documentation:
docs/content/docs/reference/cloud-api/index.mdx) documenting the REST API for managing cloud VMs and sandboxes, including base path, authentication requirements, and endpoint groupsNew Tutorials:
sandbox-to-surf-the-web.mdx- Building a sandbox with a browser for web task automationsandbox-for-hermes-and-cua-driver.mdx- Driving a sandbox with the Hermes model through Cua Driverbenchmark-with-cua-bench.mdx- Benchmarking Codex and Claude Code on computer-use tasksrl-a-model-for-computer-use.mdx- Setting up reinforcement learning loops for model training on computer-use taskssub-agent-with-mcp-sampling.mdx- Building computer-use sub-agents using MCP samplingNew How-To Guides:
build-a-linux-image.mdx- Creating custom Linux sandbox images with dependenciesbuild-a-windows-image.mdx- Creating custom Windows sandbox imagesconnect-to-a-service.mdx- Exposing and connecting to services running in sandboxesuse-the-sdk.mdx- Installing and using the Cua Sandbox Python SDKNew Explanation Pages:
images.mdx- Understanding sandbox images and their immutabilitypools.mdx- How warm pools maintain ready sandboxesclaims.mdx- How claims reserve sandboxes and express concurrencyautoscaling.mdx- How pools scale based on demandservices.mdx- How services are exposed and reached from outside sandboxesUpdated Navigation:
meta.jsonfiles to include new pages in the documentation structure across tutorials, how-to guides, explanation, and reference sectionsNotable Details
https://claude.ai/code/session_014tuBJpDJU8UCR4UQSrLkxg
Summary by CodeRabbit