Add warning to API-based Sandbox page about production use#475
Conversation
The Runtime API (runtime.all-hands.dev) was built for community benchmark evaluation at scale, not for production applications. Add a prominent warning directing users to use OpenHands Cloud Workspace instead when building production applications with the SDK. Co-authored-by: openhands <openhands@all-hands.dev>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
✅ Valuable addition - This warning clearly communicates the intended use case for the Runtime API and guides users to the right tool for production workloads.
[RISK ASSESSMENT]
- [Overall PR]
⚠️ Risk Assessment: 🟢 LOW
Documentation-only change with no code or runtime behavior modifications. The warning addresses a real user need by clarifying when to use Runtime API vs. Cloud Workspace.
Note: There is one unresolved suggestion on line 9 regarding wording. Please address that before merging.
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
🟡 Acceptable - Clear and valuable warning, but needs a quick grammar fix.
[RISK ASSESSMENT]
- [Overall PR]
⚠️ Risk Assessment: 🟢 LOW
Documentation-only change with no code or runtime behavior modifications. The warning addresses a real user need by clarifying the intended use case for the Runtime API vs. production deployments.
VERDICT:
✅ Worth merging - After fixing the grammatical error
KEY INSIGHT:
This warning prevents misuse of benchmark infrastructure for production workloads - a practical, user-focused addition.
Co-authored-by: OpenHands Bot <contact@all-hands.dev>
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Clear and valuable warning that prevents misuse of benchmark infrastructure for production workloads.
[RISK ASSESSMENT]
- [Overall PR]
⚠️ Risk Assessment: 🟢 LOW
Documentation-only change with no code or runtime behavior modifications. The warning addresses a real user need by clarifying the intended use case for the Runtime API vs. production deployments. Previous grammatical issues have been resolved.
VERDICT:
✅ Worth merging - Ready to merge
KEY INSIGHT:
This warning prevents confusion about the Runtime API's purpose, guiding users to the appropriate production solution (OpenHands Cloud Workspace) when building applications with the SDK.
3 participants
Summary
Adds a prominent warning to the API-based Sandbox documentation page clarifying that the Runtime API (
runtime.all-hands.dev) is designed for community benchmark evaluation at scale, not for building production applications.The warning directs users to the OpenHands Cloud Workspace for production use cases.
Context
The
runtime.all-hands.devservice was built to help the community run agent benchmark evaluations at scale. It was not intended to be used as a production workspace for applications built with the SDK. This warning helps set proper expectations and guides users to the right tool for their use case.Changes
<Warning>component near the top ofsdk/guides/agent-server/api-sandbox.mdxwith a clear message about the intended use of the Runtime API and a link to the recommended alternative for production.This PR was created by an AI agent (OpenHands) on behalf of the user.
@xingyaoww can click here to continue refining the PR