From c37a474dc523025a9e505c4b027c8cef42a78845 Mon Sep 17 00:00:00 2001 From: mamoodi Date: Tue, 28 May 2024 16:43:58 -0400 Subject: [PATCH] doc: Small fix for development.md and docs (#2119) --- Development.md | 6 +++--- docs/modules/usage/intro.mdx | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Development.md b/Development.md index c3e08c3321..babb42ab8f 100644 --- a/Development.md +++ b/Development.md @@ -5,8 +5,8 @@ This guide is for people working on OpenDevin and editing the source code. ### 1. Requirements * Linux, Mac OS, or [WSL on Windows](https://learn.microsoft.com/en-us/windows/wsl/install) -* [Docker](https://docs.docker.com/engine/install/)(For those on MacOS, make sure to allow the default Docker socket to be used from advanced settings!) -* [Python](https://www.python.org/downloads/) >= 3.11 +* [Docker](https://docs.docker.com/engine/install/) (For those on MacOS, make sure to allow the default Docker socket to be used from advanced settings!) +* [Python](https://www.python.org/downloads/) = 3.11 * [NodeJS](https://nodejs.org/en/download/package-manager) >= 18.17.1 * [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer) >= 1.8 @@ -98,4 +98,4 @@ Please refer to [this README](./tests/integration/README.md) for details. ### 9. Add or update dependency 1. Add your dependency in `pyproject.toml` or use `peotry add xxx` -2. Update the poetry.lock file via `poetry lock --no-update` \ No newline at end of file +2. Update the poetry.lock file via `poetry lock --no-update` diff --git a/docs/modules/usage/intro.mdx b/docs/modules/usage/intro.mdx index a5360de5d5..a6067a6e3e 100644 --- a/docs/modules/usage/intro.mdx +++ b/docs/modules/usage/intro.mdx @@ -92,7 +92,7 @@ You'll find OpenDevin running at [http://localhost:3000](http://localhost:3000). If you want to use the **(unstable!)** bleeding edge, you can use `ghcr.io/opendevin/opendevin:main` as the image (last line). ::: -See [Development.md](https://github.com/OpenDevin/OpenDevin/blob/main/Development.md) for instructions on running OpenDevin without Docker. +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).