docs(sdk): add normative invariants to architecture docs #274
+329
−14
Mintlify / Mintlify Deployment
succeeded
Jan 24, 2026 in 33s
Deployment Succeeded
Your changes are now live at https://allhandsai-openhands-sdk-arch-1815.mintlify.app!
Details
Verified update permissions
Fetching and validating config file...
Successfully validated docs.json
Fetching .mintignore file...
No .mintignore file found
file too large - skipping: openhands/static/img/teaser.mp4
Fetched all file paths
Fetched 2 OpenApi file(s):
- openapi/agent-sdk.json
- openapi/openapi.json
Fetched 0 AsyncApi file(s)
Generated OpenAPI pages for navigation
Skipped AsyncAPI navigation generation
Successfully updated API reference metadata.
No stale files found
Updating targeted paths:
sdk/arch/condenser.mdx
sdk/arch/events.mdx
Successfully updated deployment
LaTeX configuring is unchanged
Successfully saved config
Identified 1 stale tracked asset(s)
Updating navigation...
Navigation updated
Updating hidden pages noindex...
Updated 0 hidden page(s) with noindex
Skipped search indexing.
Successfully deleted stale OpenAPI document(s)
Successfully deleted stale AsyncAPI document(s)
Cached valid paths
Starting page revalidation...
Revalidating all pages...
Revalidating paths:
.openhands/microagents/app-guidelines
.openhands/microagents/sdk-arch-guidelines
.openhands/microagents/sdk-guidelines
api-reference/add-event
api-reference/alive
api-reference/create-custom-secret
api-reference/delete-conversation
api-reference/delete-custom-secret
api-reference/download-workspace-archive
api-reference/get-config
api-reference/get-conversation
api-reference/get-file-content
api-reference/get-microagents
api-reference/get-prompt
api-reference/get-remote-runtime-config
api-reference/get-repository-branches
api-reference/get-repository-microagent-content
api-reference/get-repository-microagents
api-reference/get-suggested-tasks
api-reference/get-trajectory
api-reference/get-user
api-reference/get-user-installations
api-reference/get-user-repositories
api-reference/git-changes
api-reference/git-diff
api-reference/health
api-reference/list-agents
api-reference/list-security-analyzers
api-reference/list-supported-models
api-reference/list-workspace-files
api-reference/load-custom-secrets-names
api-reference/load-settings
api-reference/new-conversation
api-reference/reset-settings
api-reference/search-conversations
api-reference/search-events
api-reference/search-repositories
api-reference/start-conversation
api-reference/stop-conversation
api-reference/store-provider-tokens
api-reference/store-settings
api-reference/submit-feedback
api-reference/unset-provider-tokens
api-reference/update-conversation
api-reference/update-custom-secret
api-reference/upload-files
openhands/DOC_STYLE_GUIDE
openhands/usage/about
openhands/usage/advanced/configuration-options
openhands/usage/advanced/custom-sandbox-guide
openhands/usage/advanced/search-engine-setup
openhands/usage/agents
openhands/usage/architecture/backend
openhands/usage/architecture/runtime
openhands/usage/cli/cloud
openhands/usage/cli/command-reference
openhands/usage/cli/critic
openhands/usage/cli/gui-server
openhands/usage/cli/headless
openhands/usage/cli/ide/jetbrains
openhands/usage/cli/ide/overview
openhands/usage/cli/ide/toad
openhands/usage/cli/ide/vscode
openhands/usage/cli/ide/zed
openhands/usage/cli/installation
openhands/usage/cli/mcp-servers
openhands/usage/cli/quick-start
openhands/usage/cli/resume
openhands/usage/cli/terminal
openhands/usage/cli/web-interface
openhands/usage/cloud/bitbucket-installation
openhands/usage/cloud/cloud-api
openhands/usage/cloud/cloud-ui
openhands/usage/cloud/github-installation
openhands/usage/cloud/gitlab-installation
openhands/usage/cloud/openhands-cloud
openhands/usage/cloud/project-management/jira-dc-integration
openhands/usage/cloud/project-management/jira-integration
openhands/usage/cloud/project-management/linear-integration
openhands/usage/cloud/project-management/overview
openhands/usage/cloud/slack-installation
openhands/usage/confirmation-mode
openhands/usage/customization/repository
openhands/usage/developers/debugging
openhands/usage/developers/development-overview
openhands/usage/developers/evaluation-harness
openhands/usage/developers/websocket-connection
openhands/usage/environment-variables
openhands/usage/key-features
openhands/usage/llms/azure-llms
openhands/usage/llms/custom-llm-configs
openhands/usage/llms/google-llms
openhands/usage/llms/groq
openhands/usage/llms/litellm-proxy
openhands/usage/llms/llms
openhands/usage/llms/local-llms
openhands/usage/llms/moonshot
openhands/usage/llms/openai-llms
openhands/usage/llms/openhands-llms
openhands/usage/llms/openrouter
openhands/usage/run-openhands/github-action
openhands/usage/run-openhands/gui-mode
openhands/usage/run-openhands/local-setup
openhands/usage/runtimes/daytona
openhands/usage/runtimes/docker
openhands/usage/runtimes/e2b
openhands/usage/runtimes/local
openhands/usage/runtimes/modal
openhands/usage/runtimes/overview
openhands/usage/runtimes/remote
openhands/usage/runtimes/runloop
openhands/usage/settings/api-keys-settings
openhands/usage/settings/application-settings
openhands/usage/settings/integrations-settings
openhands/usage/settings/llm-settings
openhands/usage/settings/mcp-settings
openhands/usage/settings/secrets-settings
openhands/usage/tips/prompting-best-practices
openhands/usage/troubleshooting/feedback
openhands/usage/troubleshooting/troubleshooting
openhands/usage/windows-without-wsl
overview/community
overview/contributing
overview/faqs
overview/first-projects
overview/introduction
overview/model-context-protocol
overview/quickstart
overview/skills
overview/skills/keyword
overview/skills/org
overview/skills/public
overview/skills/repo
sdk/api-reference/openhands.sdk.agent
sdk/api-reference/openhands.sdk.conversation
sdk/api-reference/openhands.sdk.event
sdk/api-reference/openhands.sdk.llm
sdk/api-reference/openhands.sdk.security
sdk/api-reference/openhands.sdk.tool
sdk/api-reference/openhands.sdk.utils
sdk/api-reference/openhands.sdk.workspace
sdk/arch/agent
sdk/arch/agent-server
sdk/arch/condenser
sdk/arch/conversation
sdk/arch/design
sdk/arch/events
sdk/arch/llm
sdk/arch/mcp
sdk/arch/overview
sdk/arch/sdk
sdk/arch/security
sdk/arch/skill
sdk/arch/tool-system
sdk/arch/workspace
sdk/faq
sdk/getting-started
sdk/guides/agent-browser-use
sdk/guides/agent-custom
sdk/guides/agent-delegation
sdk/guides/agent-interactive-terminal
sdk/guides/agent-server/api-reference/bash/batch-get-bash-events
sdk/guides/agent-server/api-reference/bash/clear-all-bash-events
sdk/guides/agent-server/api-reference/bash/execute-bash-command
sdk/guides/agent-server/api-reference/bash/get-bash-event
sdk/guides/agent-server/api-reference/bash/search-bash-events
sdk/guides/agent-server/api-reference/bash/start-bash-command
sdk/guides/agent-server/api-reference/conversations/ask-agent
sdk/guides/agent-server/api-reference/conversations/batch-get-conversations
sdk/guides/agent-server/api-reference/conversations/condense-conversation
sdk/guides/agent-server/api-reference/conversations/count-conversations
sdk/guides/agent-server/api-reference/conversations/delete-conversation
sdk/guides/agent-server/api-reference/conversations/generate-conversation-title
sdk/guides/agent-server/api-reference/conversations/get-conversation
sdk/guides/agent-server/api-reference/conversations/pause-conversation
sdk/guides/agent-server/api-reference/conversations/run-conversation
sdk/guides/agent-server/api-reference/conversations/search-conversations
sdk/guides/agent-server/api-reference/conversations/set-conversation-confirmation-policy
sdk/guides/agent-server/api-reference/conversations/set-conversation-security-analyzer
sdk/guides/agent-server/api-reference/conversations/start-conversation
sdk/guides/agent-server/api-reference/conversations/update-conversation
sdk/guides/agent-server/api-reference/conversations/update-conversation-secrets
sdk/guides/agent-server/api-reference/desktop/get-desktop-url
sdk/guides/agent-server/api-reference/events/batch-get-conversation-events
sdk/guides/agent-server/api-reference/events/count-conversation-events
sdk/guides/agent-server/api-reference/events/get-conversation-event
sdk/guides/agent-server/api-reference/events/respond-to-confirmation
sdk/guides/agent-server/api-reference/events/search-conversation-events
sdk/guides/agent-server/api-reference/events/send-message
sdk/guides/agent-server/api-reference/files/download-file
sdk/guides/agent-server/api-reference/files/download-trajectory
sdk/guides/agent-server/api-reference/files/upload-file
sdk/guides/agent-server/api-reference/get-server-info
sdk/guides/agent-server/api-reference/git/git-changes
sdk/guides/agent-server/api-reference/git/git-diff
sdk/guides/agent-server/api-reference/server-details/alive
sdk/guides/agent-server/api-reference/server-details/get-server-info
sdk/guides/agent-server/api-reference/server-details/health
sdk/guides/agent-server/api-reference/tools/list-available-tools
sdk/guides/agent-server/api-reference/vscode/get-vscode-status
sdk/guides/agent-server/api-reference/vscode/get-vscode-url
sdk/guides/agent-server/api-sandbox
sdk/guides/agent-server/apptainer-sandbox
sdk/guides/agent-server/cloud-workspace
sdk/guides/agent-server/custom-tools
sdk/guides/agent-server/docker-sandbox
sdk/guides/agent-server/local-server
sdk/guides/agent-server/overview
sdk/guides/agent-stuck-detector
sdk/guides/agent-tom-agent
sdk/guides/context-condenser
sdk/guides/convo-ask-agent
sdk/guides/convo-async
sdk/guides/convo-custom-visualizer
sdk/guides/convo-pause-and-resume
sdk/guides/convo-persistence
sdk/guides/convo-send-message-while-running
sdk/guides/critic
sdk/guides/custom-tools
sdk/guides/github-workflows/assign-reviews
sdk/guides/github-workflows/pr-review
sdk/guides/github-workflows/todo-management
sdk/guides/hello-world
sdk/guides/hooks
sdk/guides/iterative-refinement
sdk/guides/llm-error-handling
sdk/guides/llm-image-input
sdk/guides/llm-reasoning
sdk/guides/llm-registry
sdk/guides/llm-routing
sdk/guides/llm-streaming
sdk/guides/mcp
sdk/guides/metrics
sdk/guides/observability
sdk/guides/plugins
sdk/guides/secrets
sdk/guides/security
sdk/guides/skill
sdk/index
/modules/:slug*
/usage/:slug*
/openhands/usage/configuration-options
/openhands/usage/how-to/custom-sandbox-guide
/openhands/usage/search-engine-setup
/openhands/usage/prompting/repository
/openhands/usage/how-to/debugging
/openhands/usage/how-to/development-overview
/openhands/usage/how-to/evaluation-harness
/openhands/usage/how-to/websocket-connection
/openhands/usage/prompting/microagents-keyword
/openhands/usage/prompting/microagents-org
/openhands/usage/prompting/microagents-overview
/openhands/usage/prompting/microagents-public
/openhands/usage/prompting/microagents-repo
/openhands/usage/installation
/openhands/usage/how-to/cli-mode
/openhands/usage/how-to/github-action
/openhands/usage/how-to/gui-mode
/openhands/usage/how-to/headless-mode
/openhands/usage/local-setup
/openhands/usage/getting-started
/openhands/usage/prompting/prompting-best-practices
/openhands/usage/feedback
/openhands/usage/start-building
/overview/key-features
/openhands/usage/faqs
/index
/overview
/openhands/usage/quick-start
/openhands/overview/:slug*
/success-stories/:slug*
/openhands/success-stories/:slug*
/openhands/usage/microagents/microagents-overview
/overview/skills/overview
/openhands/usage/microagents/microagents-repo
/openhands/usage/microagents/microagents-keyword
/openhands/usage/microagents/microagents-org
/openhands/usage/microagents/microagents-public
/openhands/usage/run-openhands/cli-mode
/openhands/usage/run-openhands/cli-settings
/openhands/usage/run-openhands/acp
/openhands/usage/run-openhands/headless-mode
/openhands/usage/run-openhands/cli/resume
sdk
Page revalidation complete
Successfully deleted stale tracked asset(s)
Queued update of llms-full.txt
Queued update of skill.md
Skipping Vercel revalidation (subdomain not in revalidation list)
Updated Cloudflare deployment cache
Loading