docs: add workspace types guide and saas_runtime_mode documentation#414
Open
jpshackelford wants to merge 13 commits intomainfrom
Open
docs: add workspace types guide and saas_runtime_mode documentation#414jpshackelford wants to merge 13 commits intomainfrom
jpshackelford wants to merge 13 commits intomainfrom
Conversation
- Add new workspace-types.mdx page with comparison table and decision guide - Add SaaS Runtime Mode section to cloud-workspace.mdx explaining: - When to use saas_runtime_mode (scripts running inside Cloud sandboxes) - Configuration options and environment variables - Example automation script - Orchestration pattern for deploying automation scripts - Update docs.json navigation to include new workspace-types page This documentation supports the saas_runtime_mode feature added in software-agent-sdk PR #2490. Co-authored-by: openhands <openhands@all-hands.dev>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
Taste Rating: 🟡 Acceptable - Technically accurate but unnecessarily verbose.
Verdict: ✅ Worth merging - Documentation is solid and verified against source code.
Key Insight: You're explaining HOW too much and WHY too little. Half this text could be cut without losing clarity.
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
- Shorten workspace names and headers - Use line break in SaaS Creds header - Center checkmark columns Co-authored-by: openhands <openhands@all-hands.dev>
- Full workspace class names (e.g., OpenHandsCloudWorkspace) - Add hyperlinks to detail pages - Change header to 'SaaS Auth' Co-authored-by: openhands <openhands@all-hands.dev>
- Indicate it's for OpenHands Enterprise users - Add Warning block listing what you become responsible for - Update table to say 'Enterprise, low-level control' Co-authored-by: openhands <openhands@all-hands.dev>
- Shorter headers: 'Isolated' and 'SaaS' - Use simple checkmark only (empty for false) - Remove center alignment Co-authored-by: openhands <openhands@all-hands.dev>
Override default min-width to allow columns to shrink based on content. Co-authored-by: openhands <openhands@all-hands.dev>
The stylesheet was not being loaded because the href attribute was missing. Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
- Local Scenarios: Development/testing, Local with isolation - Remote & Integration Scenarios: - Building applications with OpenHands Cloud - CI/CD pipeline integration (comparison table) - Running SDK scripts inside Cloud sandboxes (saas_runtime_mode) - Enterprise self-managed infrastructure - Move reference tables to end of document - Add architectural diagram for nested execution pattern Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
- normal-mode.svg: Your Machine ↔ API ↔ OpenHands Cloud - saas-runtime-mode-simple.svg: Script inside Cloud sandbox Co-authored-by: openhands <openhands@all-hands.dev>
5 tasks
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
Adds documentation for choosing between workspace types and documents the new saas_runtime_mode feature from software-agent-sdk PR #2490.
Changes
Related