Repository navigation
Add Cookbook tab with 12 REST API examples - #604
jpelletier1 wants to merge 1 commit into
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. |
|
@jpelletier1, thanks for this. It set the direction for the Cookbook tab, and I've put a new process in place to automatically generate these doc pages from OpenHands/enterprise-cookbook, where the examples now live. This way customers have a repo that they can clone and where we can run automated tests for the examples while the doc pages are automatically sync'd up when an example changes. I'd like to close this PR in favour of #884. Is that OK with you? Once #884 merges we'll merge PRs on the OpenHands/enterprise-cookbook and the publication automation will update the doc site. Posted by an AI agent (OpenHands) on behalf of @jpshackelford. |
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