Skip to content

Commit 7e44c8f

Browse files
neubigneubig
authored
Update doc to clarify OpenDevin mission and link directly to content (OpenHands#2568)
* Update doc * Fix review comments
1 parent 6879acd commit 7e44c8f

3 files changed

Lines changed: 46 additions & 40 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
<div align="center">
3434
<img src="./docs/static/img/logo.png" alt="Logo" width="200" height="200">
3535
<h1 align="center">OpenDevin: Code Less, Make More</h1>
36-
<a href="https://opendevin.github.io/OpenDevin/"><img src="https://img.shields.io/badge/Documentation-OpenDevin-blue?logo=googledocs&logoColor=white&style=for-the-badge" alt="Check out the documentation"></a>
36+
<a href="https://opendevin.github.io/OpenDevin/modules/usage/intro"><img src="https://img.shields.io/badge/Documentation-OpenDevin-blue?logo=googledocs&logoColor=white&style=for-the-badge" alt="Check out the documentation"></a>
3737
<a href="https://huggingface.co/spaces/OpenDevin/evaluation"><img src="https://img.shields.io/badge/Evaluation-Benchmark%20on%20HF%20Space-green?style=for-the-badge" alt="Evaluation Benchmark"></a>
3838
</div>
3939
<hr>
@@ -76,7 +76,7 @@ OpenDevin will only have access to this workspace folder. The rest of your syste
7676
## 🚀 Documentation
7777

7878
To learn more about the project, and for tips on using OpenDevin,
79-
**check out our [documentation](https://opendevin.github.io/OpenDevin/)**.
79+
**check out our [documentation](https://opendevin.github.io/OpenDevin/modules/usage/intro)**.
8080

8181
There you'll find resources on how to use different LLM providers (like ollama and Anthropic's Claude),
8282
troubleshooting resources, and advanced configuration options.

‎docs/src/components/Welcome/Welcome.tsx‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,10 @@ export function Welcome() {
77
<div className="welcome-container">
88
<img src="img/logo.png" className="welcome-logo" />
99
<p className="welcome-text">
10-
Welcome to OpenDevin, an open-source project aiming to replicate
11-
Devin, an autonomous AI software engineer who is capable of executing
10+
Welcome to OpenDevin, an open-source autonomous AI software engineer
11+
that is capable of executing
1212
complex engineering tasks and collaborating actively with users on
13-
software development projects. This project aspires to replicate,
14-
enhance, and innovate upon Devin through the power of the open-source
15-
community.
13+
software development projects.
1614
</p>
1715
</div>
1816
</div>

‎docs/src/pages/faq.tsx‎

Lines changed: 41 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,28 @@
11
import Layout from "@theme/Layout";
22
import CustomFooter from "../components/CustomFooter";
3-
import "../css/faq.css";
3+
import "../css/faq.css";
44

55
export default function FAQ() {
66
return (
77
<>
88
<Layout title="FAQ" description="Frequently Asked Questions">
99
<div id="faq" className="faq-container">
1010
<div className="faq-title">Frequently Asked Questions</div>
11+
<div className="faq-section">
12+
<div className="faq-section-title">What is OpenDevin?</div>
13+
<p>
14+
<span className="highlight">OpenDevin</span>{" "}
15+
is an autonomous software engineer that can solve software engineering
16+
and web-browsing tasks end-to-end. It can perform data science queries, such
17+
as "Find the number of pull requests to the OpenDevin repository in the last
18+
month," and software engineering tasks, such as "Please add tests to this
19+
file and verify that all the tests pass. If they don't fix the file."
20+
</p>
21+
<p>
22+
At the same time, OpenDevin is a platform and community for agent developers
23+
to test out and evaluate new agents.
24+
</p>
25+
</div>
1126
<div className="faq-section">
1227
<div className="faq-section-title">Support</div>
1328
<div>How can I report an issue with OpenDevin?</div>
@@ -21,40 +36,12 @@ export default function FAQ() {
2136
</div>
2237
</div>
2338
<div className="faq-section">
24-
<div className="faq-section-title">General</div>
25-
<div>What is Devin?</div>
26-
<div>
27-
<span className="highlight">Devin</span>{" "}
28-
represents a cutting-edge autonomous agent designed to navigate the
29-
complexities of software engineering. It leverages a combination of
30-
tools such as a shell, code editor, and web browser, showcasing the
31-
untapped potential of LLMs in software development. Our goal is to
32-
explore and expand upon Devin's capabilities, identifying both its
33-
strengths and areas for improvement, to guide the progress of open
34-
code models.
35-
</div>
36-
</div>
37-
<div className="faq-section">
38-
<div className="faq-section-title">Why OpenDevin?</div>
39-
<p>
40-
The{" "}
41-
<span className="highlight">OpenDevin</span>{" "}
42-
project is born out of a desire to replicate, enhance, and innovate
43-
beyond the original Devin model. By engaging the{" "}
44-
<a href="https://github.com/OpenDevin/OpenDevin">
45-
open-source community
46-
</a>
47-
, we aim to tackle the challenges faced by Code LLMs in practical
48-
scenarios, producing works that significantly contribute to the
49-
community and pave the way for future advancements.
50-
</p>
51-
</div>
52-
<div className="faq-section">
53-
<div className="faq-section-title">How to fix an issue on OpenDevin?</div>
39+
<div className="faq-section-title">How to fix a GitHub issue with OpenDevin?</div>
5440
<div className="faq-steps">
55-
To fix an issue on GitHub using OpenDevin, send a prompt to OpenDevin asking it to follow these steps:
41+
To fix an issue on GitHub using OpenDevin, send a prompt to OpenDevin asking it to follow
42+
steps like the following:
5643
<ol>
57-
<li>Read the issue on <a href="https://github.com/OpenDevin/OpenDevin/issues/1611">GitHub</a></li>
44+
<li>Read the issue https://github.com/OpenDevin/OpenDevin/issues/1611</li>
5845
<li>Clone the repository and check out a new branch</li>
5946
<li>Based on the instructions in the issue description, modify files to fix the issue</li>
6047
<li>Push the resulting output to GitHub using the GITHUB_TOKEN environment variable</li>
@@ -71,6 +58,27 @@ export default function FAQ() {
7158
where USERNAME is your GitHub username.
7259
</div>
7360
</div>
61+
<div className="faq-section">
62+
<div className="faq-section-title">How is OpenDevin different from Devin?</div>
63+
<p>
64+
<a href="https://www.cognition.ai/blog/introducing-devin">Devin</a>&nbsp;
65+
is a commercial product by Cognition Inc., that served as the initial
66+
inspiration for OpenDevin. They both aim to do a good job at solving software
67+
engineering tasks, but OpenDevin you can download, use, and modify, while Devin
68+
you can only use through the Cognition site. In addition, OpenDevin has evolved
69+
beyond the initial inspiration, and now serves as a community-driven ecosystem for
70+
agent development in general, and we'd love to have you join and
71+
<a href="https://github.com/OpenDevin/OpenDevin/blob/main/CONTRIBUTING.md">contribute</a>!
72+
</p>
73+
</div>
74+
<div className="faq-section">
75+
<div className="faq-section-title">How is OpenDevin different from ChatGPT?</div>
76+
<p>
77+
ChatGPT you can access online, it does not interface with local files, and
78+
its ability to execute code is limited. So it can write code, but it is not
79+
easy to test or execute it.
80+
</p>
81+
</div>
7482
</div>
7583
</Layout>
7684
</>

0 commit comments

Comments
 (0)