diff --git a/docs/modules/usage/cloud/openhands-cloud.mdx b/docs/modules/usage/cloud/openhands-cloud.mdx index 5a72fd3cc4..6a7e067357 100644 --- a/docs/modules/usage/cloud/openhands-cloud.mdx +++ b/docs/modules/usage/cloud/openhands-cloud.mdx @@ -19,7 +19,7 @@ After visiting OpenHands Cloud, you will be asked to connect with your GitHub ac ### Adding Repository Access You can grant OpenHands specific repository access: -1. Click the `Select a GitHub project` dropdown, select `Add more repositories...`. +1. Click the `Select a Git project` dropdown, select `Add more repositories...`. 2. Select the organization, then choose the specific repositories to grant OpenHands access to.
Permission Details for Repository Access @@ -45,7 +45,7 @@ You can grant OpenHands specific repository access: ### Modifying Repository Access You can modify repository access at any time by: -* Using the same `Select a GitHub project > Add more repositories` workflow, or +* Using the same `Select a Git project > Add more repositories` workflow, or * Visiting the Settings page and selecting `Configure GitHub Repositories` under the `GitHub Settings` section. ## Conversation Persistence diff --git a/docs/modules/usage/how-to/custom-sandbox-guide.md b/docs/modules/usage/how-to/custom-sandbox-guide.md index a59962f29b..7e0ed26574 100644 --- a/docs/modules/usage/how-to/custom-sandbox-guide.md +++ b/docs/modules/usage/how-to/custom-sandbox-guide.md @@ -1,7 +1,8 @@ # Custom Sandbox :::note -This guide is for users that would like to use their own custom Docker image for the runtime, e.g. with certain tools or programming languages pre-installed +This guide is for users that would like to use their own custom Docker image for the runtime. For example +with certain tools or programming languages pre-installed. ::: The sandbox is where the agent performs its tasks. Instead of running commands directly on your computer diff --git a/docs/modules/usage/how-to/gui-mode.md b/docs/modules/usage/how-to/gui-mode.md index 5fef35dc58..54b11affc8 100644 --- a/docs/modules/usage/how-to/gui-mode.md +++ b/docs/modules/usage/how-to/gui-mode.md @@ -24,9 +24,8 @@ OpenHands supports multiple version control providers. You can configure tokens #### GitHub Token Setup -OpenHands automatically exports a `GITHUB_TOKEN` to the shell environment if it is available. This can happen in two ways: +OpenHands automatically exports a `GITHUB_TOKEN` to the shell environment if provided: -**Local Installation**: The user directly inputs their GitHub token.
Setting Up a GitHub Token @@ -40,9 +39,8 @@ OpenHands automatically exports a `GITHUB_TOKEN` to the shell environment if it - Minimal Permissions ( Select `Meta Data = Read-only` read for search, `Pull Requests = Read and Write` and `Content = Read and Write` for branch creation) 2. **Enter Token in OpenHands**: - Click the Settings button (gear icon). - - Navigate to the `Git Provider Settings` section. - Paste your token in the `GitHub Token` field. - - Click `Save Changes` to apply the changes. + - Click `Save` to apply the changes.
@@ -83,26 +81,9 @@ OpenHands automatically exports a `GITHUB_TOKEN` to the shell environment if it - Check the browser console for any error messages.
-**OpenHands Cloud**: The token is obtained through GitHub OAuth authentication. - -
- OAuth Authentication - - When using OpenHands Cloud, the GitHub OAuth flow requests the following permissions: - - Repository access (read/write) - - Workflow management - - Organization read access - - To authenticate OpenHands: - - Click `Sign in with GitHub` when prompted. - - Review the requested permissions. - - Authorize OpenHands to access your GitHub account. - - If using an organization, authorize organization access if prompted. -
- #### GitLab Token Setup -OpenHands automatically exports a `GITLAB_TOKEN` to the shell environment, for local installations only, if it is available. +OpenHands automatically exports a `GITLAB_TOKEN` to the shell environment if provided:
Setting Up a GitLab Token @@ -117,10 +98,9 @@ OpenHands automatically exports a `GITLAB_TOKEN` to the shell environment, for l - Set an expiration date or leave it blank for a non-expiring token. 2. **Enter Token in OpenHands**: - Click the Settings button (gear icon). - - Navigate to the `Git Provider Settings` section. - Paste your token in the `GitLab Token` field. - Enter your GitLab instance URL if using self-hosted GitLab. - - Click `Save Changes` to apply the changes. + - Click `Save` to apply the changes.
diff --git a/docs/modules/usage/key-features.md b/docs/modules/usage/key-features.md index 4f2fe2bd91..5f3eaa5435 100644 --- a/docs/modules/usage/key-features.md +++ b/docs/modules/usage/key-features.md @@ -12,6 +12,9 @@ * Modify files * Upload and download files +### Terminal +- A space for OpenHands and users to run terminal commands. + ### Jupyter - Shows all Python commands that were executed by OpenHands. - Particularly handy when using OpenHands to perform data visualization tasks. @@ -23,6 +26,3 @@ ### Browser - Used by OpenHands to browse websites. - The browser is non-interactive. - -### Terminal -- A space for OpenHands and users to run terminal commands. diff --git a/docs/static/img/oh-features.png b/docs/static/img/oh-features.png index 0f6d4df1f3..3d910942d0 100644 Binary files a/docs/static/img/oh-features.png and b/docs/static/img/oh-features.png differ