docs(enterprise): add Architecture overview page - #745
Draft
jpelletier1 wants to merge 2 commits into
Draft
Conversation
Adds a new Architecture page under the Enterprise tab that explains: - How OpenHands Enterprise / Cloud works end-to-end, with a Mermaid system diagram - Core components/services (OpenHands server, Keycloak, LiteLLM, Runtime API, sandboxes, object storage, image loader) - Enterprise supporting services and optional platform services (Automation service, Integrations Hub, Plugin Directory, Agent Canvas, device plugin) - Integration adapter flow (webhook -> sandbox -> callback) - Required vs. optional external systems (Kubernetes, LLM provider, Postgres, Redis, Keycloak, object storage, DNS/TLS vs. Git app integrations, Stripe, email, Datadog, Tavily, Laminar, etc.) Registers the page in docs.json under the existing 'OpenHands Enterprise' group in the Enterprise tab. 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. |
Contributor
Author
|
@OpenHands remove references to stripe in the architecture doc |
|
I'm on it! jpelletier1 can track my progress at all-hands.dev |
Co-authored-by: openhands <openhands@all-hands.dev>
Contributor
Author
|
Addressed in This comment was posted by an AI agent (OpenHands) on behalf of the user. |
|
Addressed the PR comment on #745.
No test suite was run because this was a two-line documentation-only deletion; |
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
Adds a new Architecture page under the Enterprise tab (
enterprise/architecture.mdx) that explains how OpenHands Enterprise / OpenHands Cloud works as a whole system, aimed at customers and prospects evaluating a self-hosted deployment.The page covers:
The page is registered in
docs.jsonunder the existingOpenHands Enterprisegroup in theEnterprisetab, right afterenterprise/enterprise-vs-oss.Sourcing
Content was derived from analysis of the
enterprise/repository (server, integrations, storage/migrations) and theOpenHands/OpenHands-Cloudrepository (Helm chart structure,values.yaml,ARCHITECTURE.md), cross-checked against existing docs pages (enterprise/index.mdx,enterprise/k8s-install/index.mdx,enterprise/conversations-and-sandboxes.mdx,enterprise/enterprise-vs-oss.mdx,sdk/arch/overview.mdx) for consistency of terminology, formatting, and diagram style.Validation
docs.jsonparses as valid JSON; diff is a single-line insertion (no reformatting)./enterprise/...,/openhands/usage/automations/overview,/openhands/usage/cloud/cloud-api,/openhands/usage/agent-canvas/architecture) point to existing pages.@mermaid-js/mermaid-clito confirm valid syntax.openhands/DOC_STYLE_GUIDE.mdconventions (Title Case headers, absolute internal links,<Info>/<Note>components,<Card>/<CardGroup>for next steps).llms.txt/llms-full.txt— a clean clone ofmainalready shows drift in those generated files unrelated to this change, so regenerating here would have produced an unrelated, oversized diff. Recommend leaving that to the scheduledcheck-llms-filessync workflow.This PR was created by an AI agent (OpenHands) on behalf of the user, based on an analysis of the
enterpriseandOpenHands/OpenHands-Cloudrepositories.@jpelletier1 can click here to continue refining the PR