Skip to content

πŸ™Œ OpenHands: AI-Driven Development

More doc updates (#9289)

mamoodi834abc0eee52
diff --git a/docs/docs.json b/docs/docs.json
index 641d2639a1..55456570ec 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -104,8 +104,9 @@
]
},
{
- "group": "Customization",
+ "group": "Customizations & Settings",
"pages": [
+ "usage/common-settings",
"usage/prompting/repository",
{
"group": "Microagents",
diff --git a/docs/usage/cloud/cloud-ui.mdx b/docs/usage/cloud/cloud-ui.mdx
index 108bc2aa18..492ea99949 100644
--- a/docs/usage/cloud/cloud-ui.mdx
+++ b/docs/usage/cloud/cloud-ui.mdx
@@ -1,7 +1,7 @@
---
title: Cloud UI
-description: The Cloud UI provides a web interface for interacting with OpenHands. This page explains how to use the
- OpenHands Cloud UI.
+description: The Cloud UI provides a web interface for interacting with OpenHands. This page provides references on
+ how to use the OpenHands Cloud UI.
---
## Landing Page
@@ -22,8 +22,9 @@ The Settings page allows you to:
- [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.
-- Create API keys to work with OpenHands programmatically.
+- [Generate custom secrets](/usage/common-settings#secrets-management).
+- [Create API keys to work with OpenHands programmatically](/usage/cloud/cloud-api).
+- Change your email address.
## Key Features
diff --git a/docs/usage/cloud/slack-installation.mdx b/docs/usage/cloud/slack-installation.mdx
index 5be898437c..540c353fcc 100644
--- a/docs/usage/cloud/slack-installation.mdx
+++ b/docs/usage/cloud/slack-installation.mdx
@@ -25,7 +25,7 @@ description: This guide walks you through installing the OpenHands Slack app.
**Make sure your Slack workspace admin/owner has installed OpenHands Slack App first.**
- Every user in the Slack workspace (including admins/owners) must link their Cloud OpenHands account to the OpenHands Slack App. To do this:
+ Every user in the Slack workspace (including admins/owners) must link their OpenHands Cloud account to the OpenHands Slack App. To do this:
1. Visit [integrations settings](https://app.all-hands.dev/settings/integrations) in OpenHands Cloud.
2. Click `Install OpenHands Slack App`.
3. In the top right corner, select the workspace to install the OpenHands Slack app.
diff --git a/docs/usage/common-settings.mdx b/docs/usage/common-settings.mdx
new file mode 100644
index 0000000000..cf08a8cd53
--- /dev/null
+++ b/docs/usage/common-settings.mdx
@@ -0,0 +1,52 @@
+---
+title: OpenHands Settings
+description: Overview of some of the settings available in OpenHands.
+---
+
+## Openhands Cloud vs Running on Your Own
+
+There are some differences between the settings available in OpenHands Cloud and those available when running OpenHands
+on your own:
+* [OpenHands Cloud settings](/usage/cloud/cloud-ui#settings)
+* [Settings available when running on your own](/usage/how-to/gui-mode#settings)
+
+Refer to these pages for more detailed information.
+
+## Secrets Management
+
+OpenHands provides a secrets manager that allows you to securely store and manage sensitive information that can be
+accessed by the agent during runtime, such as API keys. These secrets are automatically exported as environment
+variables in the agent's runtime environment.
+
+### Accessing the Secrets Manager
+
+In the Settings page, navigate to the `Secrets` tab. Here, you'll see a list of all your existing custom secrets.
+
+### Adding a New Secret
+1. Click `Add a new secret`.
+2. Fill in the following fields:
+ - **Name**: A unique identifier for your secret (e.g., `AWS_ACCESS_KEY`). This will be the environment variable name.
+ - **Value**: The sensitive information you want to store.
+ - **Description** (optional): A brief description of what the secret is used for, which is also provided to the agent.
+3. Click `Add secret` to save.
+
+### Editing a Secret
+
+1. Click the `Edit` button next to the secret you want to modify.
+2. You can update the name and description of the secret.
+<Note>
+ For security reasons, you cannot view or edit the value of an existing secret. If you need to change the
+ value, delete the secret and create a new one.
+</Note>
+
+### Deleting a Secret
+
+1. Click the `Delete` button next to the secret you want to remove.
+2. Select `Confirm` to delete the secret.
+
+### Using Secrets in the Agent
+ - All custom secrets are automatically exported as environment variables in the agent's runtime environment.
+ - You can access them in your code using standard environment variable access methods
+ (e.g., `os.environ['SECRET_NAME']` in Python).
+ - Example: If you create a secret named `OPENAI_API_KEY`, you can access it in your code as
+ `process.env.OPENAI_API_KEY` in JavaScript or `os.environ['OPENAI_API_KEY']` in Python.
diff --git a/docs/usage/getting-started.mdx b/docs/usage/getting-started.mdx
index 6cdf766938..3f22e9bcdb 100644
--- a/docs/usage/getting-started.mdx
+++ b/docs/usage/getting-started.mdx
@@ -1,6 +1,6 @@
---
title: Start Building
-description: So you've [run OpenHands](./installation) and have [set up your LLM](./installation#setup). Now what?
+description: So you've [run OpenHands](/usage/installation). Now what?
icon: code
---
diff --git a/docs/usage/how-to/gui-mode.mdx b/docs/usage/how-to/gui-mode.mdx
index d1e24dd898..5d6dfdfd2b 100644
--- a/docs/usage/how-to/gui-mode.mdx
+++ b/docs/usage/how-to/gui-mode.mdx
@@ -25,9 +25,9 @@ You can use the Settings page at any time to:
- Setup the LLM provider and model for OpenHands.
- [Setup the search engine](/usage/search-engine-setup).
- [Configure MCP servers](/usage/mcp).
-- [Connect to GitHub](/usage/how-to/gui-mode#github-setup) and [connect to GitLab](/usage/how-to/gui-mode#gitlab-setup)
+- [Connect to GitHub](/usage/how-to/gui-mode#github-setup) and [connect to GitLab](/usage/how-to/gui-mode#gitlab-setup).
- Set application settings like your preferred language, notifications and other preferences.
-- [Manage custom secrets](/usage/how-to/gui-mode#secrets-management).
+- [Manage custom secrets](/usage/common-settings#secrets-management).
#### GitHub Setup
@@ -157,37 +157,6 @@ OpenHands automatically exports a `GITLAB_TOKEN` to the shell environment if pro
</AccordionGroup>
-
-#### Secrets Management
-
-OpenHands provides a secrets manager that allows you to securely store and manage sensitive information that can be accessed by the agent during runtime, such as API keys. These secrets are automatically exported as environment variables in the agent's runtime environment.
-
-1. **Accessing the Secrets Manager**:
- - In the Settings page, navigate to the `Secrets` tab.
- - You'll see a list of all your existing custom secrets (if any).
-
-2. **Adding a New Secret**:
- - Click the `Add New Secret` button.
- - Fill in the following fields:
- - **Name**: A unique identifier for your secret (e.g., `AWS_ACCESS_KEY`). This will be the environment variable name.
- - **Value**: The sensitive information you want to store.
- - **Description** (optional): A brief description of what the secret is used for, which is also provided to the agent.
- - Click `Add Secret` to save.
-
-3. **Editing a Secret**:
- - Click the `Edit` button next to the secret you want to modify.
- - You can update the name and description of the secret.
- - Note: For security reasons, you cannot view or edit the value of an existing secret. If you need to change the value, delete the secret and create a new one.
-
-4. **Deleting a Secret**:
- - Click the `Delete` button next to the secret you want to remove.
- - Confirm the deletion when prompted.
-
-5. **Using Secrets in the Agent**:
- - All custom secrets are automatically exported as environment variables in the agent's runtime environment.
- - You can access them in your code using standard environment variable access methods (e.g., `os.environ['SECRET_NAME']` in Python).
- - Example: If you create a secret named `OPENAI_API_KEY`, you can access it in your code as `process.env.OPENAI_API_KEY` in JavaScript or `os.environ['OPENAI_API_KEY']` in Python.
-
#### Advanced Settings
The `Advanced` settings allows configuration of additional LLM settings. Inside the Settings page, under the `LLM` tab,
@@ -208,11 +177,11 @@ section of the documentation.
The status indicator located in the bottom left of the screen will cycle through a number of states as a new conversation
is loaded. Typically these include:
-* `Disconnected` : The frontend is not connected to any conversation
+* `Disconnected` : The frontend is not connected to any conversation.
* `Connecting` : The frontend is connecting a websocket to a conversation.
* `Building Runtime...` : The server is building a runtime. This is typically in development mode only while building a docker image.
* `Starting Runtime...` : The server is starting a new runtime instance - probably a new docker container or remote runtime.
-* `Initializing Agent...` : The server is starting the agent loop. (This step does not appear at present with Nested runtimes)
+* `Initializing Agent...` : The server is starting the agent loop (This step does not appear at present with Nested runtimes).
* `Setting up workspace...` : Usually this means a `git clone ...` operation.
* `Setting up git hooks` : Setting up the git pre commit hooks for the workspace.
* `Agent is awaiting user input...` : Ready to go!
diff --git a/docs/usage/installation.mdx b/docs/usage/installation.mdx
index 3666c938e8..5ade8323e0 100644
--- a/docs/usage/installation.mdx
+++ b/docs/usage/installation.mdx
@@ -1,6 +1,6 @@
---
title: Quick Start
-description: Running OpenHands Cloud or running on your local system.
+description: Running OpenHands Cloud or running on your own.
icon: rocket
---