From e2636f9ece1f36920c2f06f992fc362e70db0d23 Mon Sep 17 00:00:00 2001 From: mamoodi Date: Mon, 8 Jul 2024 17:33:12 -0400 Subject: [PATCH] docs: Reorder docs and small update to README (#2860) Co-authored-by: Mahmoud Work --- README.md | 4 +++- docs/modules/usage/about.md | 2 +- docs/modules/usage/architecture.mdx | 2 +- docs/modules/usage/custom_sandbox_guide.md | 24 +++++++++++-------- docs/modules/usage/feedback.md | 2 +- .../usage/troubleshooting/troubleshooting.md | 2 +- 6 files changed, 21 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 2b2957a3d1..3beab757a3 100644 --- a/README.md +++ b/README.md @@ -75,9 +75,11 @@ docker run -it \ > Choose the tag that best suits your needs based on stability requirements and desired features. 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`. - 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. +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 +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. + For the development workflow, see [Development.md](https://github.com/OpenDevin/OpenDevin/blob/main/Development.md). Are you having trouble? Check out our [Troubleshooting Guide](https://opendevin.github.io/OpenDevin/modules/usage/troubleshooting). diff --git a/docs/modules/usage/about.md b/docs/modules/usage/about.md index 334ff3636c..3c80f89a47 100644 --- a/docs/modules/usage/about.md +++ b/docs/modules/usage/about.md @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 8 --- # 📚 Misc diff --git a/docs/modules/usage/architecture.mdx b/docs/modules/usage/architecture.mdx index 5691873a0b..1a3173e9f7 100644 --- a/docs/modules/usage/architecture.mdx +++ b/docs/modules/usage/architecture.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 7 --- # 🏛️ System Architecture Overview diff --git a/docs/modules/usage/custom_sandbox_guide.md b/docs/modules/usage/custom_sandbox_guide.md index c689711e90..125fb4b754 100644 --- a/docs/modules/usage/custom_sandbox_guide.md +++ b/docs/modules/usage/custom_sandbox_guide.md @@ -1,14 +1,18 @@ -# 💿 How to Create a Custom Docker Sandbox +--- +sidebar_position: 6 +--- + +# 💿 How to Create and Use a Custom Docker Sandbox The default OpenDevin sandbox comes with a [minimal ubuntu configuration](https://github.com/OpenDevin/OpenDevin/blob/main/containers/sandbox/Dockerfile). Your use case may need additional software installed by default. There are two ways you can do so: -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. -2. Creating your own custom docker image. +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 +2. Creating your own custom docker image and using it -If you want to take the first approach, you can skip the next section. +If you want to take the first approach, you can skip the `Create Your Docker Image` section. ## Setup @@ -17,7 +21,7 @@ Make sure you are able to run OpenDevin using the [Development.md](https://githu ## Create Your Docker Image To create a custom docker image, it must be debian/ubuntu based. -For example, if we want OpenDevin to have access to the "node" binary, we would use the following Dockerfile: +For example, if we want OpenDevin to have access to the `node` binary, we would use the following Dockerfile: ```dockerfile # Start with latest ubuntu image @@ -30,9 +34,9 @@ RUN apt-get update && apt-get install -y RUN apt-get install -y nodejs ``` -Next build your docker image with the name of your choice, for example "custom_image". +Next build your docker image with the name of your choice, for example `custom_image`. -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: +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: ```bash docker build -t custom_image . @@ -58,9 +62,9 @@ run_as_devin=true sandbox_container_image="custom_image" ``` -For sandbox_container_image, you can specify either: -1. The name of your custom image that you built in the previous step (e.g., "custom_image") -2. A pre-existing image from Docker Hub (e.g., "node:20" if you want a sandbox with Node.js pre-installed) +For `sandbox_container_image`, you can specify either: +1. The name of your custom image that you built in the previous step (e.g., `”custom_image”`) +2. A pre-existing image from Docker Hub (e.g., `”node:20”` if you want a sandbox with Node.js pre-installed) ## Run Run OpenDevin by running ```make run``` in the top level directory. diff --git a/docs/modules/usage/feedback.md b/docs/modules/usage/feedback.md index 245c193bcd..b5b0152f7c 100644 --- a/docs/modules/usage/feedback.md +++ b/docs/modules/usage/feedback.md @@ -1,5 +1,5 @@ --- -sidebar_position: 6 +sidebar_position: 5 --- # ✅ Providing Feedback diff --git a/docs/modules/usage/troubleshooting/troubleshooting.md b/docs/modules/usage/troubleshooting/troubleshooting.md index 173f8a8b6d..61af30fbae 100644 --- a/docs/modules/usage/troubleshooting/troubleshooting.md +++ b/docs/modules/usage/troubleshooting/troubleshooting.md @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 4 --- # 🚧 Troubleshooting