OpenHands Documentation

This repository provides a unified documentation site powered by Mintlify.

• docs.json - Mintlify configuration file that references docs in these repos.
• openhands/ - Main OpenHands docs.
• openapi/ - API References.
• sdk/ - Agent SDK docs.
• success-stories/ - Success stories docs.

To run the documentation site locally:

npm install -g mint
# or
yarn global add mint

# Preview local changes
mint dev

The documentation site is automatically deployed via Mintlify when changes are pushed to the main branch.

Mintlify generates llms.txt and llms-full.txt when the site deploys. There are no checked-in overrides or regeneration jobs.

docs.json sets seo.indexing to "navigable". Legacy V0 and former monorepo architecture pages have noindex: true in their MDX frontmatter, so they stay accessible to readers but are excluded from the generated LLM files, search, sitemaps, and AI assistant context. Pages outside navigation are also omitted. When adding legacy documentation, include noindex: true; when adding current documentation, include it in the navigation. See AGENTS.md for the full policy and Mintlify's documentation.

This site documents a multi-repository OpenHands system. OpenHands/OpenHands owns Agent Canvas, OpenHands/software-agent-sdk owns the Python SDK and Agent Server, OpenHands/typescript-client owns the browser client for the Agent Server API, OpenHands/automation owns scheduling and dispatch, and OpenHands/extensions owns reusable skills, plugins, automations, and integrations.

The usual API flow is SDK/Agent Server → OpenAPI contract → TypeScript client → Agent Canvas. Documentation should preserve these ownership boundaries; a PR opened in the wrong repository should be closed and moved to the repository that owns the change.