docs: separate Agent SDK from Hosted Agents in the nav#358
Merged
Conversation
The SDK agent docs (sandbox.agent.*) existed but were orphaned from the nav — readers landing on "Agents" only saw the hosted Cores/Channels world (Hermes, OpenClaw) and had no way to discover the in-sandbox agent API. Promote those pages into a dedicated "Agent SDK" group, rename the existing group to "Hosted Agents", and cross-link the two overviews so each points at the other. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
2027 — Running evals on commit
|
| URL | Mapping |
|---|---|
| digger.dev | → opensandbox-docs-agent-sdk-nav.mintlify.app |
| opencomputer.dev | → opensandbox-docs-agent-sdk-nav.mintlify.app |
2027 // complete the getting started guide at https://opencomputer.d — Running…
▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
Prompt
complete the getting started guide at https://opencomputer.dev
Commit a704d0a · View metrics →
Evaluating agent experience using 2027.dev · View dashboard
The "long-lived vs single task" framing was inaccurate: the hosted API also runs ephemeral, one-task-per-sandbox sessions (POST /v1/agents/:id/sessions). Reframe the split around who manages the runtime — SDK-driven in-sandbox Claude sessions vs platform-managed agent definitions reached via persistent instances or ephemeral sessions. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
What
The docs for the in-sandbox agent API (
sandbox.agent.startfrom@opencomputer/sdk) already exist —agents/overview,agents/tools,agents/events,agents/multi-turn— but they were orphaned: not referenced anywhere indocs.json, so unreachable from the sidebar. A reader landing on "Agents" only saw the hosted world (Cores/Hermes/OpenClaw, Channels, REST) and would conclude that's the only way to run an agent.This surfaced while building the
demo-agent-triagedemo, which is built entirely onsandbox.agent.startand couldn't find supporting docs.Changes
docs.json— split the single "Agents" nav group into two top-level groups:agents/overview,agents/tools,agents/events,agents/multi-turn(the in-sandbox agent API)agents/overview.mdx— retitled (H1 "Run an agent in a sandbox", sidebar "Overview"); added a callout distinguishing the SDK path from Hosted Agents, with a cross-link.agents-api/overview.mdx— mirror callout linking back to the Agent SDK.No content was deleted; existing pages are just regrouped and cross-linked.
Notes
main; contains only these 3 doc files.🤖 Generated with Claude Code