Add Cookbook tab with 12 REST API examples#604
Draft
jpelletier1 wants to merge 1 commit into
Draft
Conversation
Adds a new 'Cookbook' navigation tab sourced from jpshackelford/oh-examples. Creates 13 MDX pages organized into 4 groups: - Sandboxes: start-sandbox, clone-and-attach - Conversations: conversation-metrics, conversation-tags, per-conversation-secrets - Plugins & Skills: load-plugin, launch-plugin-badge, upload-skills, test-mcp-config - Hooks: command-blacklist, command-whitelist, workspace-isolation 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. |
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 of changes
Adds a new Cookbook navigation tab to the docs site, sourced from jpshackelford/oh-examples. The Cookbook is a collection of standalone, runnable Python examples that show how to use the OpenHands Cloud REST API.
What's added
docs.json— new"Cookbook"tab entry with 4 sidebar groups.13 new pages under
cookbook/:cookbook/index.mdx— overview with CardGroup tiles, API overview table, and links to all examplesstart-sandbox— create a sandbox and run commands directly against the agent-server;clone-and-attach— provision a sandbox (clone + setup.sh) then attach a conversationconversation-metrics— CLI tool for cost/token usage (V0 + V1 auto-detect);conversation-tags— write/read key-value metadata on a conversation;per-conversation-secrets— inject secrets as bash env vars or MCP auth placeholdersload-plugin— thepluginsfield that pre-loads a plugin at conversation-start;launch-plugin-badge— build no-code/launchlinks, HTML buttons, and README badges;upload-skills— upload a skills directory into a sandbox;test-mcp-config— validate MCP server configs viaPOST /api/mcp/testcommand-blacklist— PreToolUse hook blocking dangerous patterns;command-whitelist— PreToolUse hook allowing only an approved command list;workspace-isolation— enforce directory boundaries on bothterminalandfile_editorEach page follows the doc style guide (frontmatter, code blocks,
<Note>components, internal cross-links) and links back to the source files on GitHub.This pull request was created by an AI agent (OpenHands) on behalf of the user.
@jpelletier1 can click here to continue refining the PR