diff --git a/README.md b/README.md index 6a45b986cd..f75dfb04d3 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@
Logo

OpenDevin: Code Less, Make More

- Check out the documentation + Check out the documentation Evaluation Benchmark

@@ -76,7 +76,7 @@ OpenDevin will only have access to this workspace folder. The rest of your syste ## 🚀 Documentation To learn more about the project, and for tips on using OpenDevin, -**check out our [documentation](https://opendevin.github.io/OpenDevin/)**. +**check out our [documentation](https://opendevin.github.io/OpenDevin/modules/usage/intro)**. There you'll find resources on how to use different LLM providers (like ollama and Anthropic's Claude), troubleshooting resources, and advanced configuration options. diff --git a/docs/src/components/Welcome/Welcome.tsx b/docs/src/components/Welcome/Welcome.tsx index fc206e59d5..a8042b4596 100644 --- a/docs/src/components/Welcome/Welcome.tsx +++ b/docs/src/components/Welcome/Welcome.tsx @@ -7,12 +7,10 @@ export function Welcome() {

- Welcome to OpenDevin, an open-source project aiming to replicate - Devin, an autonomous AI software engineer who is capable of executing + Welcome to OpenDevin, an open-source autonomous AI software engineer + that is capable of executing complex engineering tasks and collaborating actively with users on - software development projects. This project aspires to replicate, - enhance, and innovate upon Devin through the power of the open-source - community. + software development projects.

diff --git a/docs/src/pages/faq.tsx b/docs/src/pages/faq.tsx index 397aa7abd4..70957c59e8 100644 --- a/docs/src/pages/faq.tsx +++ b/docs/src/pages/faq.tsx @@ -1,6 +1,6 @@ import Layout from "@theme/Layout"; import CustomFooter from "../components/CustomFooter"; -import "../css/faq.css"; +import "../css/faq.css"; export default function FAQ() { return ( @@ -8,6 +8,21 @@ export default function FAQ() {
Frequently Asked Questions
+
+
What is OpenDevin?
+

+ OpenDevin{" "} + is an autonomous software engineer that can solve software engineering + and web-browsing tasks end-to-end. It can perform data science queries, such + as "Find the number of pull requests to the OpenDevin repository in the last + month," and software engineering tasks, such as "Please add tests to this + file and verify that all the tests pass. If they don't fix the file." +

+

+ At the same time, OpenDevin is a platform and community for agent developers + to test out and evaluate new agents. +

+
Support
How can I report an issue with OpenDevin?
@@ -21,40 +36,12 @@ export default function FAQ() {
-
General
-
What is Devin?
-
- Devin{" "} - represents a cutting-edge autonomous agent designed to navigate the - complexities of software engineering. It leverages a combination of - tools such as a shell, code editor, and web browser, showcasing the - untapped potential of LLMs in software development. Our goal is to - explore and expand upon Devin's capabilities, identifying both its - strengths and areas for improvement, to guide the progress of open - code models. -
-
-
-
Why OpenDevin?
-

- The{" "} - OpenDevin{" "} - project is born out of a desire to replicate, enhance, and innovate - beyond the original Devin model. By engaging the{" "} - - open-source community - - , we aim to tackle the challenges faced by Code LLMs in practical - scenarios, producing works that significantly contribute to the - community and pave the way for future advancements. -

-
-
-
How to fix an issue on OpenDevin?
+
How to fix a GitHub issue with OpenDevin?
- To fix an issue on GitHub using OpenDevin, send a prompt to OpenDevin asking it to follow these steps: + To fix an issue on GitHub using OpenDevin, send a prompt to OpenDevin asking it to follow + steps like the following:
    -
  1. Read the issue on GitHub
  2. +
  3. Read the issue https://github.com/OpenDevin/OpenDevin/issues/1611
  4. Clone the repository and check out a new branch
  5. Based on the instructions in the issue description, modify files to fix the issue
  6. Push the resulting output to GitHub using the GITHUB_TOKEN environment variable
  7. @@ -71,6 +58,27 @@ export default function FAQ() { where USERNAME is your GitHub username.
+
+
How is OpenDevin different from Devin?
+

+ Devin  + is a commercial product by Cognition Inc., that served as the initial + inspiration for OpenDevin. They both aim to do a good job at solving software + engineering tasks, but OpenDevin you can download, use, and modify, while Devin + you can only use through the Cognition site. In addition, OpenDevin has evolved + beyond the initial inspiration, and now serves as a community-driven ecosystem for + agent development in general, and we'd love to have you join and + contribute! +

+
+
+
How is OpenDevin different from ChatGPT?
+

+ ChatGPT you can access online, it does not interface with local files, and + its ability to execute code is limited. So it can write code, but it is not + easy to test or execute it. +

+