π OpenHands: AI-Driven Development
Update parts of the OpenHands Cloud docs (#11107)
mamoodif8f74858da32
diff --git a/docs/static/img/api-key-generation.png b/docs/static/img/api-key-generation.pngdeleted file mode 100644index 7506076401..0000000000Binary files a/docs/static/img/api-key-generation.png and /dev/null differdiff --git a/docs/static/img/connect-repo-no-github.png b/docs/static/img/connect-repo-no-github.pngdeleted file mode 100644index bbc3af3c3a..0000000000Binary files a/docs/static/img/connect-repo-no-github.png and /dev/null differdiff --git a/docs/static/img/connect-repo.png b/docs/static/img/connect-repo.pngindex 9eb86dc79a..9e5ef94476 100644Binary files a/docs/static/img/connect-repo.png and b/docs/static/img/connect-repo.png differdiff --git a/docs/static/img/oh-features.png b/docs/static/img/oh-features.pngindex 3f4236d065..8647d0d378 100644Binary files a/docs/static/img/oh-features.png and b/docs/static/img/oh-features.png differdiff --git a/docs/static/img/screenshot.png b/docs/static/img/screenshot.pngdeleted file mode 100644index 2027ac2a2d..0000000000Binary files a/docs/static/img/screenshot.png and /dev/null differdiff --git a/docs/usage/cloud/bitbucket-installation.mdx b/docs/usage/cloud/bitbucket-installation.mdxindex da42a19cb1..7f6e15595a 100644--- a/docs/usage/cloud/bitbucket-installation.mdx+++ b/docs/usage/cloud/bitbucket-installation.mdx@@ -8,9 +8,21 @@ description: This guide walks you through the process of installing OpenHands Cl- Signed in to [OpenHands Cloud](https://app.all-hands.dev) with [a Bitbucket account](/usage/cloud/openhands-cloud).+## Adding Bitbucket Repository Access++Upon signing into OpenHands Cloud with a Bitbucket account, OpenHands will have access to your repositories.++## Working With Bitbucket Repos in Openhands Cloud++After signing in with a Bitbucket account, use the `Open Repository` section to select the appropriate repository and+branch you'd like OpenHands to work on. Then click on `Launch` to start the conversation!+++## IP Whitelisting-If your Bitbucket Cloud instance has IP restrictions, you'll need to whitelist the following IP addresses to allow OpenHands to access your repositories:+If your Bitbucket Cloud instance has IP restrictions, you'll need to whitelist the following IP addresses to allow+OpenHands to access your repositories:### Core App IP```@@ -31,17 +43,6 @@ If your Bitbucket Cloud instance has IP restrictions, you'll need to whitelist t34.60.55.59```-## Adding Bitbucket Repository Access--Upon signing into OpenHands Cloud with a Bitbucket account, OpenHands will have access to your repositories.--## Working With Bitbucket Repos in Openhands Cloud--After signing in with a Bitbucket account, use the `select a repo` and `select a branch` dropdowns to select the-appropriate repository and branch you'd like OpenHands to work on. Then click on `Launch` to start the conversation!---## Next Steps- [Learn about the Cloud UI](/usage/cloud/cloud-ui).diff --git a/docs/usage/cloud/cloud-api.mdx b/docs/usage/cloud/cloud-api.mdxindex 12438a6b70..656a173984 100644--- a/docs/usage/cloud/cloud-api.mdx+++ b/docs/usage/cloud/cloud-api.mdx@@ -12,13 +12,10 @@ For the available API endpoints, refer to theTo use the OpenHands Cloud API, you'll need to generate an API key:1. Log in to your [OpenHands Cloud](https://app.all-hands.dev) account.-2. Navigate to the [Settings page](https://app.all-hands.dev/settings).-3. Select the `API Keys` tab.-4. Click `Create API Key`.-5. Give your key a descriptive name (Example: "Development" or "Production") and select `Create`.-6. Copy the generated API key and store it securely. It will only be shown once.--+2. Navigate to the [Settings > API Keys](https://app.all-hands.dev/settings/api-keys) page.+3. Click `Create API Key`.+4. Give your key a descriptive name (Example: "Development" or "Production") and select `Create`.+5. Copy the generated API key and store it securely. It will only be shown once.## API Usagediff --git a/docs/usage/cloud/cloud-ui.mdx b/docs/usage/cloud/cloud-ui.mdxindex d63ac66c99..1bb93f3655 100644--- a/docs/usage/cloud/cloud-ui.mdx+++ b/docs/usage/cloud/cloud-ui.mdx@@ -8,24 +8,39 @@ description: The Cloud UI provides a web interface for interacting with OpenHandThe landing page is where you can:-- [Add GitHub repository access](/usage/cloud/github-installation#adding-github-repository-access) to OpenHands.- [Select a GitHub repo](/usage/cloud/github-installation#working-with-github-repos-in-openhands-cloud),[a GitLab repo](/usage/cloud/gitlab-installation#working-with-gitlab-repos-in-openhands-cloud) or[a Bitbucket repo](/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.-- Launch an empty conversation using `Launch from Scratch`.+- See your `Recent Conversations`.## Settings-The Settings page allows you to:--- [Configure GitHub repository access](/usage/cloud/github-installation#modifying-repository-access) for OpenHands.-- [Install the OpenHands Slack app](/usage/cloud/slack-installation).-- Set application settings like your preferred language, notifications and other preferences.-- Add credits to your account.-- [Generate custom secrets](/usage/common-settings#secrets-management).-- [Create API keys to work with OpenHands programmatically](/usage/cloud/cloud-api).-- Change your email address.+Settings are divided across tabs, with each tab focusing on a specific area of configuration.++- `User`+ - Change your email address.+- `Integrations`+ - [Configure GitHub repository access](/usage/cloud/github-installation#modifying-repository-access) for OpenHands.+ - [Install the OpenHands Slack app](/usage/cloud/slack-installation).+- `Application`+ - Set your preferred language, notifications and other preferences.+ - Toggle task suggestions on GitHub.+ - Toggle Solvability Analysis.+ - Set a maximum budget per conversation.+ - Configure the username and email that OpenHands uses for commits.+- `LLM` (Available for `Pro Users`)+ - Choose to use another LLM or use different models from the OpenHands provider.+- `Billing`+ - Add credits for using the OpenHands provider.+ - Cancel your `Pro` subscription.+- `Secrets`+ - [Generate custom secrets](/usage/common-settings#secrets-management).+- `API Keys`+ - [Create API keys to work with OpenHands programmatically](/usage/cloud/cloud-api).+- `MCP`+ - [Setup an MCP server](/usage/mcp)## Key Featuresdiff --git a/docs/usage/cloud/github-installation.mdx b/docs/usage/cloud/github-installation.mdxindex ae0428b0c1..68636eadb6 100644--- a/docs/usage/cloud/github-installation.mdx+++ b/docs/usage/cloud/github-installation.mdx@@ -12,7 +12,7 @@ description: This guide walks you through the process of installing OpenHands ClYou can grant OpenHands access to specific GitHub repositories:-1. Click on `Add GitHub repos` on the landing page.+1. Click on `+ Add GitHub Repos` in the repository selection dropdown.2. Select your organization and choose the specific repositories to grant OpenHands access to.<Accordion title="OpenHands permissions">- OpenHands requests short-lived tokens (8-hour expiration) with these permissions:@@ -34,20 +34,22 @@ You can grant OpenHands access to specific GitHub repositories:## Modifying Repository AccessYou can modify GitHub repository access at any time by:-- Selecting `Add GitHub repos` on the landing page or-- Visiting the Settings page and selecting `Configure GitHub Repositories` under the `Integrations` tab+- Selecting `+ Add GitHub Repos` in the repository selection dropdown or+- Visiting the `Settings > Integrations` page and selecting `Configure GitHub Repositories`## Working With GitHub Repos in Openhands Cloud-Once you've granted GitHub repository access, you can start working with your GitHub repository. Use the `select a repo`-and `select a branch` dropdowns to select the appropriate repository and branch you'd like OpenHands to work on. Then-click on `Launch` to start the conversation!+Once you've granted GitHub repository access, you can start working with your GitHub repository. Use the+`Open Repository` section to select the appropriate repository and branch you'd like OpenHands to work on. Then click+on `Launch` to start the conversation!-## Working on Github Issues and Pull Requests Using Openhands+## Working on GitHub Issues and Pull Requests Using Openhands-Giving GitHub repository access to OpenHands also allows you to work on GitHub issues and pull requests directly.+To allow OpenHands to work directly from GitHub directly, you must+[give OpenHands access to your repository](/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@@ -64,7 +66,12 @@ To get OpenHands to work on pull requests, mention `@openhands` in the comments- Request updates- Get code explanations-**Important Note**: The `@openhands` mention functionality in pull requests only works if the pull request is both *to* and *from* a repository that you have added through the interface. This is because OpenHands needs appropriate permissions to access both repositories.+<Note>+The `@openhands` mention functionality in pull requests only works if the pull request is both+*to* and *from* a repository that you have added through the interface. This is because OpenHands needs appropriate+permissions to access both repositories.+</Note>+## Next Stepsdiff --git a/docs/usage/cloud/gitlab-installation.mdx b/docs/usage/cloud/gitlab-installation.mdxindex 46111d17e3..51819a5f42 100644--- a/docs/usage/cloud/gitlab-installation.mdx+++ b/docs/usage/cloud/gitlab-installation.mdx@@ -14,16 +14,17 @@ Upon signing into OpenHands Cloud with a GitLab account, OpenHands will have acc## Working With GitLab Repos in Openhands Cloud-After signing in with a Gitlab account, use the `select a repo` and `select a branch` dropdowns to select the-appropriate repository and branch you'd like OpenHands to work on. Then click on `Launch` to start the conversation!+After signing in with a Gitlab account, use the `Open Repository` section to select the appropriate repository and+branch you'd like OpenHands to work on. Then click on `Launch` to start the conversation!-+## Using Tokens with Reduced ScopesOpenHands requests an API-scoped token during OAuth authentication. By default, this token is provided to the agent.-To restrict the agent's permissions, you can define a custom secret `GITLAB_TOKEN`, which will override the default token assigned to the agent.-While the high-permission API token is still requested and used for other components of the application (e.g. opening merge requests), the agent will not have access to it.+To restrict the agent's permissions, you can define a custom secret `GITLAB_TOKEN`, which will override the default+token assigned to the agent. While the high-permission API token is still requested and used for other components of+the application (e.g. opening merge requests), the agent will not have access to it.## Working on GitLab Issues and Merge Requests Using Openhands@@ -32,7 +33,8 @@ This feature works for personal projects and is available for group projects wit[Premium or Ultimate tier subscription](https://docs.gitlab.com/user/project/integrations/webhooks/#group-webhooks).A webhook is automatically installed within a few minutes after the owner/maintainer of the project or group logs into-OpenHands Cloud. If you decide to delete the webhook, then re-installing will require the support of All Hands AI but we are planning to improve this in a future release.+OpenHands Cloud. If you decide to delete the webhook, then re-installing will require the support of All Hands AI but+we are planning to improve this in a future release.</Note>Giving GitLab repository access to OpenHands also allows you to work on GitLab issues and merge requests directly.diff --git a/docs/usage/cloud/slack-installation.mdx b/docs/usage/cloud/slack-installation.mdxindex 34c8a8f372..1fe4d33259 100644--- a/docs/usage/cloud/slack-installation.mdx+++ b/docs/usage/cloud/slack-installation.mdx@@ -13,7 +13,9 @@ description: This guide walks you through installing the OpenHands Slack app.</iframe><Info>-OpenHands utilizes a large language model (LLM), which may generate responses that are inaccurate or incomplete. While we strive for accuracy, OpenHands' outputs are not guaranteed to be correct, and we encourage users to validate critical information independently.+OpenHands utilizes a large language model (LLM), which may generate responses that are inaccurate or incomplete.+While we strive for accuracy, OpenHands' outputs are not guaranteed to be correct, and we encourage users to+validate critical information independently.</Info>## Prerequisites