Skip to content

Commit e2636f9

Browse files
mamoodiMahmoud Work
andauthored
docs: Reorder docs and small update to README (OpenHands#2860)
Co-authored-by: Mahmoud Work <[email protected]>
1 parent 351127d commit e2636f9

6 files changed

Lines changed: 21 additions & 15 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,11 @@ docker run -it \
7575
> Choose the tag that best suits your needs based on stability requirements and desired features.
7676
7777
You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000) with access to `./workspace`. To have OpenDevin operate on your code, place it in `./workspace`.
78-
7978
OpenDevin will only have access to this workspace folder. The rest of your system will not be affected as it runs in a secured docker sandbox.
8079

80+
Upon opening OpenDevin, you must select the appropriate `Model` and enter the `API Key` within the settings that should pop up automatically. These can be set at any time by selecting
81+
the `Settings` button (gear icon) in the UI. If the required `Model` does not exist in the list, you can manually enter it in the text box.
82+
8183
For the development workflow, see [Development.md](https://github.com/OpenDevin/OpenDevin/blob/main/Development.md).
8284

8385
Are you having trouble? Check out our [Troubleshooting Guide](https://opendevin.github.io/OpenDevin/modules/usage/troubleshooting).

docs/modules/usage/about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 7
2+
sidebar_position: 8
33
---
44

55
# 📚 Misc

docs/modules/usage/architecture.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 4
2+
sidebar_position: 7
33
---
44

55
# 🏛️ System Architecture Overview

docs/modules/usage/custom_sandbox_guide.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
# 💿 How to Create a Custom Docker Sandbox
1+
---
2+
sidebar_position: 6
3+
---
4+
5+
# 💿 How to Create and Use a Custom Docker Sandbox
26

37
The default OpenDevin sandbox comes with a [minimal ubuntu configuration](https://github.com/OpenDevin/OpenDevin/blob/main/containers/sandbox/Dockerfile).
48

59
Your use case may need additional software installed by default.
610

711
There are two ways you can do so:
8-
1. Use an existing image from docker hub. For instance, if you want to have `nodejs` installed, you can do so by using the `node:20` image.
9-
2. Creating your own custom docker image.
12+
1. Use an existing image from docker hub. For instance, if you want to have `nodejs` installed, you can do so by using the `node:20` image
13+
2. Creating your own custom docker image and using it
1014

11-
If you want to take the first approach, you can skip the next section.
15+
If you want to take the first approach, you can skip the `Create Your Docker Image` section.
1216

1317
## Setup
1418

@@ -17,7 +21,7 @@ Make sure you are able to run OpenDevin using the [Development.md](https://githu
1721
## Create Your Docker Image
1822
To create a custom docker image, it must be debian/ubuntu based.
1923

20-
For example, if we want OpenDevin to have access to the "node" binary, we would use the following Dockerfile:
24+
For example, if we want OpenDevin to have access to the `node` binary, we would use the following Dockerfile:
2125

2226
```dockerfile
2327
# Start with latest ubuntu image
@@ -30,9 +34,9 @@ RUN apt-get update && apt-get install -y
3034
RUN apt-get install -y nodejs
3135
```
3236

33-
Next build your docker image with the name of your choice, for example "custom_image".
37+
Next build your docker image with the name of your choice, for example `custom_image`.
3438

35-
To do this you can create a directory and put your file inside it with the name "Dockerfile", and inside the directory run the following command:
39+
To do this you can create a directory and put your file inside it with the name `Dockerfile`, and inside the directory run the following command:
3640

3741
```bash
3842
docker build -t custom_image .
@@ -58,9 +62,9 @@ run_as_devin=true
5862
sandbox_container_image="custom_image"
5963
```
6064

61-
For sandbox_container_image, you can specify either:
62-
1. The name of your custom image that you built in the previous step (e.g., "custom_image")
63-
2. A pre-existing image from Docker Hub (e.g., "node:20" if you want a sandbox with Node.js pre-installed)
65+
For `sandbox_container_image`, you can specify either:
66+
1. The name of your custom image that you built in the previous step (e.g., `custom_image`)
67+
2. A pre-existing image from Docker Hub (e.g., `node:20` if you want a sandbox with Node.js pre-installed)
6468

6569
## Run
6670
Run OpenDevin by running ```make run``` in the top level directory.

docs/modules/usage/feedback.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 6
2+
sidebar_position: 5
33
---
44

55
# ✅ Providing Feedback

docs/modules/usage/troubleshooting/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 5
2+
sidebar_position: 4
33
---
44

55
# 🚧 Troubleshooting

0 commit comments

Comments
 (0)