diff --git a/AGENTS.md b/AGENTS.md index a8e99f357..b08c5becf 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -151,7 +151,7 @@ Workflow: `.github/workflows/sync-agent-sdk-openapi.yml` - Follow the style rules in `openhands/DOC_STYLE_GUIDE.md`. - Use Mintlify components (``, ``, ``, etc.) where appropriate. - When linking internally, prefer **absolute** doc paths (e.g. `/overview/quickstart`). -- Cloud integration docs live under `openhands/usage/cloud/`, and pages surfaced in **Documentation → Integrations → Cloud API** must also be added to the `Cloud API` group in `docs.json`. +- Cloud-tab-owned docs now live under `enterprise/usage/` (including `enterprise/usage/cloud/`), with redirects preserved from the legacy `openhands/usage/...` routes; pages surfaced in **Documentation → Integrations → Cloud API** must also be added to the `Cloud API` group in `docs.json`. ### Mintlify tab ownership diff --git a/docs.json b/docs.json index 62905d8df..194e65b83 100644 --- a/docs.json +++ b/docs.json @@ -380,32 +380,31 @@ { "group": "OpenHands Cloud", "pages": [ - "openhands/usage/cloud/openhands-cloud", - "openhands/usage/cloud/cloud-ui" + "enterprise/usage/cloud/openhands-cloud", + "enterprise/usage/cloud/cloud-ui" ] }, { "group": "Settings", "pages": [ - "openhands/usage/settings/integrations-settings", - "openhands/usage/settings/api-keys-settings" + "enterprise/usage/settings/integrations-settings", + "enterprise/usage/settings/api-keys-settings" ] }, { "group": "Integrations", "pages": [ - "openhands/usage/settings/integrations-settings", - "openhands/usage/cloud/github-installation", - "openhands/usage/cloud/gitlab-installation", - "openhands/usage/cloud/bitbucket-installation", - "openhands/usage/cloud/slack-installation", - "openhands/usage/cloud/project-management/jira-integration", + "enterprise/usage/cloud/github-installation", + "enterprise/usage/cloud/gitlab-installation", + "enterprise/usage/cloud/bitbucket-installation", + "enterprise/usage/cloud/slack-installation", + "enterprise/usage/cloud/project-management/jira-integration", { "group": "Cloud API", "pages": [ - "openhands/usage/cloud/cloud-api", - "openhands/usage/cloud/plugin-launcher", - "openhands/usage/api/v1" + "enterprise/usage/cloud/cloud-api", + "enterprise/usage/cloud/plugin-launcher", + "enterprise/usage/api/v1" ] } ] @@ -414,9 +413,9 @@ "group": "Automations (BETA)", "icon": "clock", "pages": [ - "openhands/usage/automations/overview", - "openhands/usage/automations/creating-automations", - "openhands/usage/automations/managing-automations" + "enterprise/usage/automations/overview", + "enterprise/usage/automations/creating-automations", + "enterprise/usage/automations/managing-automations" ] } ] @@ -503,6 +502,30 @@ "source": "/usage/:slug*", "destination": "/openhands/usage/:slug*" }, + { + "source": "/openhands/usage/cloud/:slug*", + "destination": "/enterprise/usage/cloud/:slug*" + }, + { + "source": "/openhands/usage/settings/integrations-settings", + "destination": "/enterprise/usage/settings/integrations-settings" + }, + { + "source": "/openhands/usage/settings/api-keys-settings", + "destination": "/enterprise/usage/settings/api-keys-settings" + }, + { + "source": "/openhands/usage/api/v1", + "destination": "/enterprise/usage/api/v1" + }, + { + "source": "/openhands/usage/automations/examples", + "destination": "/enterprise/usage/automations/overview" + }, + { + "source": "/openhands/usage/automations/:slug*", + "destination": "/enterprise/usage/automations/:slug*" + }, { "source": "/openhands/usage/configuration-options", "destination": "/openhands/usage/advanced/configuration-options" @@ -704,8 +727,8 @@ "destination": "/openhands/usage/v0/runtimes/V0_daytona" }, { - "source": "/openhands/usage/automations/examples", - "destination": "/openhands/usage/automations/overview" + "source": "/enterprise/usage/automations/examples", + "destination": "/enterprise/usage/automations/overview" } ] } diff --git a/openhands/usage/api/v1.mdx b/enterprise/usage/api/v1.mdx similarity index 100% rename from openhands/usage/api/v1.mdx rename to enterprise/usage/api/v1.mdx diff --git a/openhands/usage/automations/creating-automations.mdx b/enterprise/usage/automations/creating-automations.mdx similarity index 93% rename from openhands/usage/automations/creating-automations.mdx rename to enterprise/usage/automations/creating-automations.mdx index 14dd9c4ee..370a3c476 100644 --- a/openhands/usage/automations/creating-automations.mdx +++ b/enterprise/usage/automations/creating-automations.mdx @@ -81,7 +81,7 @@ The prompt is what the AI agent executes each time the automation runs. Write it Tell the automation what to do with its output: -- "Post to the #alerts Slack channel" (requires [Slack MCP](/openhands/usage/cloud/slack-installation)) +- "Post to the #alerts Slack channel" (requires [Slack MCP](/enterprise/usage/cloud/slack-installation)) - "Save to `reports/weekly-summary.md`" - "Create a GitHub issue with the findings" (automatic if you logged in with GitHub) - "Send a message via the configured notification service" @@ -137,9 +137,9 @@ Once your automation is created: - **It starts enabled** by default and will run on the next scheduled time - **You can view past runs** in the OpenHands UI - **Each run creates a conversation** you can review or continue -- **You can disable, update, or delete it** anytime (see [Managing Automations](/openhands/usage/automations/managing-automations)) +- **You can disable, update, or delete it** anytime (see [Managing Automations](/enterprise/usage/automations/managing-automations)) ## Next Steps -- [Automations overview & examples](/openhands/usage/automations/overview) -- [Manage your automations](/openhands/usage/automations/managing-automations) +- [Automations overview & examples](/enterprise/usage/automations/overview) +- [Manage your automations](/enterprise/usage/automations/managing-automations) diff --git a/openhands/usage/automations/managing-automations.mdx b/enterprise/usage/automations/managing-automations.mdx similarity index 93% rename from openhands/usage/automations/managing-automations.mdx rename to enterprise/usage/automations/managing-automations.mdx index 88bb02f00..48fa9b6d7 100644 --- a/openhands/usage/automations/managing-automations.mdx +++ b/enterprise/usage/automations/managing-automations.mdx @@ -98,5 +98,5 @@ Deleting an automation is permanent. Consider disabling it instead if you might ## Next Steps -- [Automations overview & examples](/openhands/usage/automations/overview) -- [Create new automations](/openhands/usage/automations/creating-automations) +- [Automations overview & examples](/enterprise/usage/automations/overview) +- [Create new automations](/enterprise/usage/automations/creating-automations) diff --git a/openhands/usage/automations/overview.mdx b/enterprise/usage/automations/overview.mdx similarity index 96% rename from openhands/usage/automations/overview.mdx rename to enterprise/usage/automations/overview.mdx index 85c8003c0..746b324be 100644 --- a/openhands/usage/automations/overview.mdx +++ b/enterprise/usage/automations/overview.mdx @@ -20,7 +20,7 @@ Your git provider credentials are automatically available—if you logged into O - **Send notifications**: Post updates to Slack, create GitHub issues, or send alerts -Automations can only interact with services you've configured access to. For example, posting to Slack requires the [Slack MCP integration](/openhands/usage/cloud/slack-installation). Git providers you logged in with (GitHub, GitLab, Bitbucket) are automatically available. +Automations can only interact with services you've configured access to. For example, posting to Slack requires the [Slack MCP integration](/enterprise/usage/cloud/slack-installation). Git providers you logged in with (GitHub, GitLab, Bitbucket) are automatically available. ## Two Types of Automations @@ -266,6 +266,6 @@ It should: ## Next Steps -- [Creating Automations](/openhands/usage/automations/creating-automations) — More details on writing prompts -- [Managing Automations](/openhands/usage/automations/managing-automations) — Update, disable, or delete automations +- [Creating Automations](/enterprise/usage/automations/creating-automations) — More details on writing prompts +- [Managing Automations](/enterprise/usage/automations/managing-automations) — Update, disable, or delete automations - [Use Cases Overview](/openhands/usage/use-cases/overview) — Explore the full use case guides behind these automations diff --git a/openhands/usage/cloud/bitbucket-installation.mdx b/enterprise/usage/cloud/bitbucket-installation.mdx similarity index 83% rename from openhands/usage/cloud/bitbucket-installation.mdx rename to enterprise/usage/cloud/bitbucket-installation.mdx index eeca47537..f9062d556 100644 --- a/openhands/usage/cloud/bitbucket-installation.mdx +++ b/enterprise/usage/cloud/bitbucket-installation.mdx @@ -6,7 +6,7 @@ description: This guide walks you through the process of installing OpenHands Cl ## Prerequisites -- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a Bitbucket account](/openhands/usage/cloud/openhands-cloud). +- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a Bitbucket account](/enterprise/usage/cloud/openhands-cloud). ## Adding Bitbucket Repository Access @@ -45,5 +45,5 @@ OpenHands to access your repositories: ## Next Steps -- [Learn about the Cloud UI](/openhands/usage/cloud/cloud-ui). -- [Use the Cloud API](/openhands/usage/cloud/cloud-api) to programmatically interact with OpenHands. +- [Learn about the Cloud UI](/enterprise/usage/cloud/cloud-ui). +- [Use the Cloud API](/enterprise/usage/cloud/cloud-api) to programmatically interact with OpenHands. diff --git a/openhands/usage/cloud/cloud-api.mdx b/enterprise/usage/cloud/cloud-api.mdx similarity index 100% rename from openhands/usage/cloud/cloud-api.mdx rename to enterprise/usage/cloud/cloud-api.mdx diff --git a/openhands/usage/cloud/cloud-ui.mdx b/enterprise/usage/cloud/cloud-ui.mdx similarity index 61% rename from openhands/usage/cloud/cloud-ui.mdx rename to enterprise/usage/cloud/cloud-ui.mdx index 09cbb9206..d12cc8053 100644 --- a/openhands/usage/cloud/cloud-ui.mdx +++ b/enterprise/usage/cloud/cloud-ui.mdx @@ -8,9 +8,9 @@ description: The Cloud UI provides a web interface for interacting with OpenHand The landing page is where you can: -- [Select a GitHub repo](/openhands/usage/cloud/github-installation#working-with-github-repos-in-openhands-cloud), - [a GitLab repo](/openhands/usage/cloud/gitlab-installation#working-with-gitlab-repos-in-openhands-cloud) or - [a Bitbucket repo](/openhands/usage/cloud/bitbucket-installation#working-with-bitbucket-repos-in-openhands-cloud) to start working on. +- [Select a GitHub repo](/enterprise/usage/cloud/github-installation#working-with-github-repos-in-openhands-cloud), + [a GitLab repo](/enterprise/usage/cloud/gitlab-installation#working-with-gitlab-repos-in-openhands-cloud) or + [a Bitbucket repo](/enterprise/usage/cloud/bitbucket-installation#working-with-bitbucket-repos-in-openhands-cloud) to start working on. - Launch an empty conversation using `New Conversation`. - See `Suggested Tasks` for repositories that OpenHands has access to. - See your `Recent Conversations`. @@ -22,8 +22,8 @@ Settings are divided across tabs, with each tab focusing on a specific area of c - `User` - Change your email address. - `Integrations` - - [Configure GitHub repository access](/openhands/usage/cloud/github-installation#modifying-repository-access) for OpenHands. - - [Install the OpenHands Slack app](/openhands/usage/cloud/slack-installation). + - [Configure GitHub repository access](/enterprise/usage/cloud/github-installation#modifying-repository-access) for OpenHands. + - [Install the OpenHands Slack app](/enterprise/usage/cloud/slack-installation). - `Application` - Set your preferred language, notifications and other preferences. - Toggle task suggestions on GitHub. @@ -37,7 +37,7 @@ Settings are divided across tabs, with each tab focusing on a specific area of c - `Secrets` - [Manage secrets](/openhands/usage/settings/secrets-settings). - `API Keys` - - [Create API keys to work with OpenHands programmatically](/openhands/usage/cloud/cloud-api). + - [Create API keys to work with OpenHands programmatically](/enterprise/usage/cloud/cloud-api). - `MCP` - [Setup an MCP server](/openhands/usage/settings/mcp-settings) @@ -48,6 +48,6 @@ section of the documentation. ## Next Steps -- [Use OpenHands with your GitHub repositories](/openhands/usage/cloud/github-installation). -- [Use OpenHands with your GitLab repositories](/openhands/usage/cloud/gitlab-installation). -- [Use the Cloud API](/openhands/usage/cloud/cloud-api) to programmatically interact with OpenHands. +- [Use OpenHands with your GitHub repositories](/enterprise/usage/cloud/github-installation). +- [Use OpenHands with your GitLab repositories](/enterprise/usage/cloud/gitlab-installation). +- [Use the Cloud API](/enterprise/usage/cloud/cloud-api) to programmatically interact with OpenHands. diff --git a/openhands/usage/cloud/github-installation.mdx b/enterprise/usage/cloud/github-installation.mdx similarity index 89% rename from openhands/usage/cloud/github-installation.mdx rename to enterprise/usage/cloud/github-installation.mdx index ce4a5de97..059251e6a 100644 --- a/openhands/usage/cloud/github-installation.mdx +++ b/enterprise/usage/cloud/github-installation.mdx @@ -6,7 +6,7 @@ description: This guide walks you through the process of installing OpenHands Cl ## Prerequisites -- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a GitHub account](/openhands/usage/cloud/openhands-cloud). +- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a GitHub account](/enterprise/usage/cloud/openhands-cloud). ## Adding GitHub Repository Access @@ -48,7 +48,7 @@ on `Launch` to start the conversation! ## Working on GitHub Issues and Pull Requests Using Openhands To allow OpenHands to work directly from GitHub directly, you must -[give OpenHands access to your repository](/openhands/usage/cloud/github-installation#modifying-repository-access). Once access is +[give OpenHands access to your repository](/enterprise/usage/cloud/github-installation#modifying-repository-access). Once access is given, you can use OpenHands by labeling the issue or by tagging `@openhands`. ### Working with Issues @@ -75,5 +75,5 @@ permissions to access both repositories. ## Next Steps -- [Learn about the Cloud UI](/openhands/usage/cloud/cloud-ui). -- [Use the Cloud API](/openhands/usage/cloud/cloud-api) to programmatically interact with OpenHands. +- [Learn about the Cloud UI](/enterprise/usage/cloud/cloud-ui). +- [Use the Cloud API](/enterprise/usage/cloud/cloud-api) to programmatically interact with OpenHands. diff --git a/openhands/usage/cloud/gitlab-installation.mdx b/enterprise/usage/cloud/gitlab-installation.mdx similarity index 95% rename from openhands/usage/cloud/gitlab-installation.mdx rename to enterprise/usage/cloud/gitlab-installation.mdx index 25235fa2e..aad8d7e0f 100644 --- a/openhands/usage/cloud/gitlab-installation.mdx +++ b/enterprise/usage/cloud/gitlab-installation.mdx @@ -7,7 +7,7 @@ description: ## Prerequisites -- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a GitLab account](/openhands/usage/cloud/openhands-cloud). +- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a GitLab account](/enterprise/usage/cloud/openhands-cloud). ## Adding GitLab Repository Access @@ -114,5 +114,5 @@ If a webhook is not installed or has failed, you can reinstall it: ## Next Steps -- [Learn about the Cloud UI](/openhands/usage/cloud/cloud-ui). -- [Use the Cloud API](/openhands/usage/cloud/cloud-api) to programmatically interact with OpenHands. +- [Learn about the Cloud UI](/enterprise/usage/cloud/cloud-ui). +- [Use the Cloud API](/enterprise/usage/cloud/cloud-api) to programmatically interact with OpenHands. diff --git a/openhands/usage/cloud/openhands-cloud.mdx b/enterprise/usage/cloud/openhands-cloud.mdx similarity index 64% rename from openhands/usage/cloud/openhands-cloud.mdx rename to enterprise/usage/cloud/openhands-cloud.mdx index 022ecbd4f..0e439f80e 100644 --- a/openhands/usage/cloud/openhands-cloud.mdx +++ b/enterprise/usage/cloud/openhands-cloud.mdx @@ -20,8 +20,8 @@ You'll be prompted to connect with your GitHub, GitLab or Bitbucket account: Once you've connected your account, you can: -- [Use OpenHands with your GitHub repositories](/openhands/usage/cloud/github-installation). -- [Use OpenHands with your GitLab repositories](/openhands/usage/cloud/gitlab-installation). -- [Use OpenHands with your Bitbucket repositories](/openhands/usage/cloud/bitbucket-installation). -- [Learn about the Cloud UI](/openhands/usage/cloud/cloud-ui). -- [Install the OpenHands Slack app](/openhands/usage/cloud/slack-installation). +- [Use OpenHands with your GitHub repositories](/enterprise/usage/cloud/github-installation). +- [Use OpenHands with your GitLab repositories](/enterprise/usage/cloud/gitlab-installation). +- [Use OpenHands with your Bitbucket repositories](/enterprise/usage/cloud/bitbucket-installation). +- [Learn about the Cloud UI](/enterprise/usage/cloud/cloud-ui). +- [Install the OpenHands Slack app](/enterprise/usage/cloud/slack-installation). diff --git a/openhands/usage/cloud/plugin-launcher.mdx b/enterprise/usage/cloud/plugin-launcher.mdx similarity index 91% rename from openhands/usage/cloud/plugin-launcher.mdx rename to enterprise/usage/cloud/plugin-launcher.mdx index 1daadef89..fc218239d 100644 --- a/openhands/usage/cloud/plugin-launcher.mdx +++ b/enterprise/usage/cloud/plugin-launcher.mdx @@ -12,7 +12,7 @@ This is useful for: - building internal test pages for plugin development - `/launch` is a Cloud route, not a standalone REST endpoint. After the user opens the link and confirms the plugin configuration, OpenHands starts a conversation using the normal V1 conversation flow described in the [Cloud API guide](/openhands/usage/cloud/cloud-api). + `/launch` is a Cloud route, not a standalone REST endpoint. After the user opens the link and confirms the plugin configuration, OpenHands starts a conversation using the normal V1 conversation flow described in the [Cloud API guide](/enterprise/usage/cloud/cloud-api). ## Before You Start @@ -103,5 +103,5 @@ This format is convenient for manual testing, but the encoded `plugins` format i ## Next Steps -- Use the [Cloud API guide](/openhands/usage/cloud/cloud-api) for authentication and conversation lifecycle details. -- See the [REST API (V1) overview](/openhands/usage/api/v1) for the V1 endpoints behind Cloud conversations. +- Use the [Cloud API guide](/enterprise/usage/cloud/cloud-api) for authentication and conversation lifecycle details. +- See the [REST API (V1) overview](/enterprise/usage/api/v1) for the V1 endpoints behind Cloud conversations. diff --git a/openhands/usage/cloud/project-management/jira-dc-integration.mdx b/enterprise/usage/cloud/project-management/jira-dc-integration.mdx similarity index 100% rename from openhands/usage/cloud/project-management/jira-dc-integration.mdx rename to enterprise/usage/cloud/project-management/jira-dc-integration.mdx diff --git a/openhands/usage/cloud/project-management/jira-integration.mdx b/enterprise/usage/cloud/project-management/jira-integration.mdx similarity index 100% rename from openhands/usage/cloud/project-management/jira-integration.mdx rename to enterprise/usage/cloud/project-management/jira-integration.mdx diff --git a/openhands/usage/cloud/project-management/linear-integration.mdx b/enterprise/usage/cloud/project-management/linear-integration.mdx similarity index 100% rename from openhands/usage/cloud/project-management/linear-integration.mdx rename to enterprise/usage/cloud/project-management/linear-integration.mdx diff --git a/openhands/usage/cloud/project-management/overview.mdx b/enterprise/usage/cloud/project-management/overview.mdx similarity index 100% rename from openhands/usage/cloud/project-management/overview.mdx rename to enterprise/usage/cloud/project-management/overview.mdx diff --git a/openhands/usage/cloud/slack-installation.mdx b/enterprise/usage/cloud/slack-installation.mdx similarity index 100% rename from openhands/usage/cloud/slack-installation.mdx rename to enterprise/usage/cloud/slack-installation.mdx diff --git a/openhands/usage/settings/api-keys-settings.mdx b/enterprise/usage/settings/api-keys-settings.mdx similarity index 89% rename from openhands/usage/settings/api-keys-settings.mdx rename to enterprise/usage/settings/api-keys-settings.mdx index 7e03d7d70..19bb888da 100644 --- a/openhands/usage/settings/api-keys-settings.mdx +++ b/enterprise/usage/settings/api-keys-settings.mdx @@ -4,7 +4,7 @@ description: View your OpenHands LLM key and create API keys to work with OpenHa --- - These settings are only available in [OpenHands Cloud](/openhands/usage/cloud/openhands-cloud). + These settings are only available in [OpenHands Cloud](/enterprise/usage/cloud/openhands-cloud). ## Overview @@ -25,7 +25,7 @@ use credits from your OpenHands Cloud account. If you need to refresh it at anyt ## OpenHands API Key These keys can be used to programmatically interact with OpenHands Cloud. See the guide for using the -[OpenHands Cloud API](/openhands/usage/cloud/cloud-api). +[OpenHands Cloud API](/enterprise/usage/cloud/cloud-api). ### Create API Key diff --git a/openhands/usage/settings/integrations-settings.mdx b/enterprise/usage/settings/integrations-settings.mdx similarity index 93% rename from openhands/usage/settings/integrations-settings.mdx rename to enterprise/usage/settings/integrations-settings.mdx index 774148c24..bf04138f9 100644 --- a/openhands/usage/settings/integrations-settings.mdx +++ b/enterprise/usage/settings/integrations-settings.mdx @@ -7,23 +7,23 @@ description: How to setup and modify the various integrations in OpenHands. OpenHands offers several integrations, including GitHub, GitLab, Bitbucket, and Slack, with more to come. Some integrations, like Slack, are only available in OpenHands Cloud. Configuration may also vary depending on whether -you're using [OpenHands Cloud](/openhands/usage/cloud/openhands-cloud) or +you're using [OpenHands Cloud](/enterprise/usage/cloud/openhands-cloud) or [running OpenHands on your own](/openhands/usage/run-openhands/local-setup). ## OpenHands Cloud Integrations Settings - These settings are only available in [OpenHands Cloud](/openhands/usage/cloud/openhands-cloud). + These settings are only available in [OpenHands Cloud](/enterprise/usage/cloud/openhands-cloud). ### GitHub Settings - `Configure GitHub Repositories` - Allows you to -[modify GitHub repository access](/openhands/usage/cloud/github-installation#modifying-repository-access) for OpenHands. +[modify GitHub repository access](/enterprise/usage/cloud/github-installation#modifying-repository-access) for OpenHands. ### Slack Settings -- `Install OpenHands Slack App` - Install [the OpenHands Slack app](/openhands/usage/cloud/slack-installation) in +- `Install OpenHands Slack App` - Install [the OpenHands Slack app](/enterprise/usage/cloud/slack-installation) in your Slack workspace. Make sure your Slack workspace admin/owner has installed the OpenHands Slack app first. ## Running on Your Own Integrations Settings diff --git a/openhands/usage/cli/cloud.mdx b/openhands/usage/cli/cloud.mdx index a9a173959..0b154d502 100644 --- a/openhands/usage/cli/cloud.mdx +++ b/openhands/usage/cli/cloud.mdx @@ -5,7 +5,7 @@ description: Create and manage OpenHands Cloud conversations from the CLI ## Overview -The OpenHands CLI provides commands to interact with [OpenHands Cloud](/openhands/usage/cloud/openhands-cloud) directly from your terminal. You can: +The OpenHands CLI provides commands to interact with [OpenHands Cloud](/enterprise/usage/cloud/openhands-cloud) directly from your terminal. You can: - Authenticate with your OpenHands Cloud account - Create new cloud conversations @@ -125,6 +125,6 @@ Use OpenHands Cloud for collaboration, on-the-go access, or when you don't want ## See Also -- [OpenHands Cloud](/openhands/usage/cloud/openhands-cloud) - Full cloud documentation -- [Cloud UI](/openhands/usage/cloud/cloud-ui) - Web interface guide -- [Cloud API](/openhands/usage/cloud/cloud-api) - Programmatic access +- [OpenHands Cloud](/enterprise/usage/cloud/openhands-cloud) - Full cloud documentation +- [Cloud UI](/enterprise/usage/cloud/cloud-ui) - Web interface guide +- [Cloud API](/enterprise/usage/cloud/cloud-api) - Programmatic access diff --git a/openhands/usage/cli/gui-server.mdx b/openhands/usage/cli/gui-server.mdx index adaaebdf8..952f2d538 100644 --- a/openhands/usage/cli/gui-server.mdx +++ b/openhands/usage/cli/gui-server.mdx @@ -5,7 +5,7 @@ description: Launch the full OpenHands web GUI using Docker ## Overview -The `openhands serve` command launches the full OpenHands GUI server using Docker. This provides the same rich web interface as [OpenHands Cloud](/openhands/usage/cloud/openhands-cloud), but running locally on your machine. +The `openhands serve` command launches the full OpenHands GUI server using Docker. This provides the same rich web interface as [OpenHands Cloud](/enterprise/usage/cloud/openhands-cloud), but running locally on your machine. ```bash openhands serve diff --git a/openhands/usage/llms/openhands-llms.mdx b/openhands/usage/llms/openhands-llms.mdx index 326a6551f..c20dc8d8f 100644 --- a/openhands/usage/llms/openhands-llms.mdx +++ b/openhands/usage/llms/openhands-llms.mdx @@ -5,7 +5,7 @@ description: OpenHands LLM provider with access to state-of-the-art (SOTA) agent ## Obtain Your OpenHands LLM API Key -1. [Log in to OpenHands Cloud](/openhands/usage/cloud/openhands-cloud). +1. [Log in to OpenHands Cloud](/enterprise/usage/cloud/openhands-cloud). 2. Go to the Settings page and navigate to the `API Keys` tab. 3. Copy your `LLM API Key`. @@ -55,7 +55,7 @@ export LLM_MODEL="openhands/claude-sonnet-4-20250514" Unable to find token in cache or `LiteLLM_VerificationTokenTable` ``` -OpenHands Cloud API Keys work with the [Cloud API](https://docs.openhands.dev/openhands/usage/cloud/cloud-api), while OpenHands LLM API Keys work with your chosen LLM via the OpenHands provider. +OpenHands Cloud API Keys work with the [Cloud API](https://docs.openhands.dev/enterprise/usage/cloud/cloud-api), while OpenHands LLM API Keys work with your chosen LLM via the OpenHands provider. ### Example diff --git a/openhands/usage/run-openhands/gui-mode.mdx b/openhands/usage/run-openhands/gui-mode.mdx index 0eef5a0c6..b81ec8dd6 100644 --- a/openhands/usage/run-openhands/gui-mode.mdx +++ b/openhands/usage/run-openhands/gui-mode.mdx @@ -88,9 +88,9 @@ You can use the Settings page at any time to: - [Setup the LLM provider and model for OpenHands](/openhands/usage/settings/llm-settings). - [Setup the search engine](/openhands/usage/advanced/search-engine-setup). - [Configure MCP servers](/openhands/usage/settings/mcp-settings). -- [Connect to GitHub](/openhands/usage/settings/integrations-settings#github-setup), - [connect to GitLab](/openhands/usage/settings/integrations-settings#gitlab-setup) - and [connect to Bitbucket](/openhands/usage/settings/integrations-settings#bitbucket-setup). +- [Connect to GitHub](/enterprise/usage/settings/integrations-settings#github-setup), + [connect to GitLab](/enterprise/usage/settings/integrations-settings#gitlab-setup) + and [connect to Bitbucket](/enterprise/usage/settings/integrations-settings#bitbucket-setup). - Set application settings like your preferred language, notifications and other preferences. - [Manage custom secrets](/openhands/usage/settings/secrets-settings). diff --git a/openhands/usage/sandboxes/remote.mdx b/openhands/usage/sandboxes/remote.mdx index 68e4fc911..4cb7db8c4 100644 --- a/openhands/usage/sandboxes/remote.mdx +++ b/openhands/usage/sandboxes/remote.mdx @@ -30,4 +30,4 @@ variable names depend on your deployment, but you may see legacy names like: depending on the provider. - Configuration and credentials vary by deployment. -If you are using OpenHands Cloud, see the [Cloud UI guide](/openhands/usage/cloud/cloud-ui). +If you are using OpenHands Cloud, see the [Cloud UI guide](/enterprise/usage/cloud/cloud-ui). diff --git a/openhands/usage/use-cases/code-review.mdx b/openhands/usage/use-cases/code-review.mdx index 94c6ddc19..61717d610 100644 --- a/openhands/usage/use-cases/code-review.mdx +++ b/openhands/usage/use-cases/code-review.mdx @@ -283,5 +283,5 @@ as a GitHub Action instead. - [PR Review Plugin](https://github.com/OpenHands/extensions/tree/main/plugins/pr-review) - Full workflow example and agent script - [Composite Action](https://github.com/OpenHands/extensions/blob/main/plugins/pr-review/action.yml) - Reusable GitHub Action for PR reviews - [Software Agent SDK](/sdk/index) - Build your own AI-powered workflows -- [GitHub Integration](/openhands/usage/cloud/github-installation) - Set up GitHub integration for OpenHands Cloud +- [GitHub Integration](/enterprise/usage/cloud/github-installation) - Set up GitHub integration for OpenHands Cloud - [Skills Documentation](/overview/skills) - Learn more about OpenHands skills diff --git a/openhands/usage/use-cases/incident-triage.mdx b/openhands/usage/use-cases/incident-triage.mdx index f5156b919..608df2eee 100644 --- a/openhands/usage/use-cases/incident-triage.mdx +++ b/openhands/usage/use-cases/incident-triage.mdx @@ -65,7 +65,7 @@ When the workflow runs, it automatically performs the following steps: The agent identifies the exact file and line number where errors originate, determines root causes, and provides specific recommendations for fixes. -The workflow posts findings to GitHub issues for human review before any code changes are made. If you want the agent to create a fix, you can follow up using the [OpenHands GitHub integration](https://docs.openhands.dev/openhands/usage/cloud/github-installation#github-integration) and say `@openhands go ahead and create a pull request to fix this issue based on your analysis`. +The workflow posts findings to GitHub issues for human review before any code changes are made. If you want the agent to create a fix, you can follow up using the [OpenHands GitHub integration](https://docs.openhands.dev/enterprise/usage/cloud/github-installation#github-integration) and say `@openhands go ahead and create a pull request to fix this issue based on your analysis`. ## Setting Up the Workflow diff --git a/overview/faqs.mdx b/overview/faqs.mdx index dc78f6d43..0604bc1ce 100644 --- a/overview/faqs.mdx +++ b/overview/faqs.mdx @@ -7,10 +7,10 @@ description: Frequently asked questions about OpenHands. ### I'm new to OpenHands. Where should I start? -1. **Quick start**: Use [OpenHands Cloud](/openhands/usage/cloud/openhands-cloud) to get started quickly with - [GitHub](/openhands/usage/cloud/github-installation), [GitLab](/openhands/usage/cloud/gitlab-installation), - [Bitbucket](/openhands/usage/cloud/bitbucket-installation), - and [Slack](/openhands/usage/cloud/slack-installation) integrations. +1. **Quick start**: Use [OpenHands Cloud](/enterprise/usage/cloud/openhands-cloud) to get started quickly with + [GitHub](/enterprise/usage/cloud/github-installation), [GitLab](/enterprise/usage/cloud/gitlab-installation), + [Bitbucket](/enterprise/usage/cloud/bitbucket-installation), + and [Slack](/enterprise/usage/cloud/slack-installation) integrations. 2. **Run on your own**: If you prefer to run it on your own hardware, follow our [Getting Started guide](/openhands/usage/run-openhands/local-setup). 3. **First steps**: Read over the [first projects guidelines](/overview/first-projects) and [prompting best practices](/openhands/usage/tips/prompting-best-practices) to learn the basics. diff --git a/overview/first-projects.mdx b/overview/first-projects.mdx index 56d61075f..9d334c504 100644 --- a/overview/first-projects.mdx +++ b/overview/first-projects.mdx @@ -62,9 +62,9 @@ Want to add new functionality to an existing repo? OpenHands can do that too. If you're running OpenHands on your own, first add a -[GitHub token](/openhands/usage/settings/integrations-settings#github-setup), -[GitLab token](/openhands/usage/settings/integrations-settings#gitlab-setup) or -[Bitbucket token](/openhands/usage/settings/integrations-settings#bitbucket-setup). +[GitHub token](/enterprise/usage/settings/integrations-settings#github-setup), +[GitLab token](/enterprise/usage/settings/integrations-settings#gitlab-setup) or +[Bitbucket token](/enterprise/usage/settings/integrations-settings#bitbucket-setup). Choose your repository and branch via `Open Repository`, and press `Launch`. diff --git a/overview/model-context-protocol.mdx b/overview/model-context-protocol.mdx index eaebd4443..50e5b495d 100644 --- a/overview/model-context-protocol.mdx +++ b/overview/model-context-protocol.mdx @@ -21,7 +21,7 @@ When OpenHands starts, it: | **CLI** | ✅ Full Support | `~/.openhands/mcp.json` file | [CLI MCP Servers](/openhands/usage/cli/mcp-servers) | | **SDK** | ✅ Full Support | Programmatic configuration | [SDK MCP Guide](/sdk/guides/mcp) | | **Local GUI** | ✅ Full Support | Settings UI + config files | [Local GUI](/openhands/usage/run-openhands/local-setup) | -| **OpenHands Cloud** | ✅ Full Support | Cloud UI settings | [Cloud GUI](/openhands/usage/cloud/cloud-ui) | +| **OpenHands Cloud** | ✅ Full Support | Cloud UI settings | [Cloud GUI](/enterprise/usage/cloud/cloud-ui) | ## Platform-Specific Differences diff --git a/overview/skills.mdx b/overview/skills.mdx index b7f266cc3..3f9cf6865 100644 --- a/overview/skills.mdx +++ b/overview/skills.mdx @@ -101,7 +101,7 @@ Each skill file may include frontmatter that provides additional information. In | **CLI** | ✅ Full Support | `~/.agents/skills/` (user-level) and `.agents/skills/` (repo-level) | File-based markdown | [Skills Overview](/overview/skills) | | **SDK** | ✅ Full Support | Programmatic `Skill` objects | Code-based configuration | [SDK Skills Guide](/sdk/guides/skill) | | **Local GUI** | ✅ Full Support | `.agents/skills/` + UI | File-based with UI management | [Local Setup](/openhands/usage/run-openhands/local-setup) | -| **OpenHands Cloud** | ✅ Full Support | Cloud UI + repository integration | Managed skill library | [Cloud UI](/openhands/usage/cloud/cloud-ui) | +| **OpenHands Cloud** | ✅ Full Support | Cloud UI + repository integration | Managed skill library | [Cloud UI](/enterprise/usage/cloud/cloud-ui) | ## Platform-Specific Differences diff --git a/sdk/index.mdx b/sdk/index.mdx index 07ed9e81d..1ea2db4d2 100644 --- a/sdk/index.mdx +++ b/sdk/index.mdx @@ -13,7 +13,7 @@ You can use the OpenHands Software Agent SDK for: - Routine maintenance tasks, like updating dependencies - Major tasks that involve multiple agents, like refactors and rewrites -You can even use the SDK to build new developer experiences—it’s the engine behind the [OpenHands CLI](/openhands/usage/cli/quick-start) and [OpenHands Cloud](/openhands/usage/cloud/openhands-cloud). +You can even use the SDK to build new developer experiences—it’s the engine behind the [OpenHands CLI](/openhands/usage/cli/quick-start) and [OpenHands Cloud](/enterprise/usage/cloud/openhands-cloud). Get started with some examples or keep reading to learn more.