Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Add GitHub Codespaces in README #2975

Closed
wants to merge 1 commit into from

Conversation

SmartManoj
Copy link
Contributor

What is the problem that this fixes or functionality that this introduces? Does it fix any open issues?

This change is separated from #2689 to avoid the blockage.

@SmartManoj SmartManoj marked this pull request as draft July 17, 2024 04:52
@SmartManoj SmartManoj marked this pull request as ready for review July 17, 2024 04:52
SmartManoj added a commit to SmartManoj/Kevin that referenced this pull request Jul 17, 2024
@@ -45,6 +45,9 @@ OpenDevin agents collaborate with human developers to write code, fix bugs, and
![App screenshot](./docs/static/img/screenshot.png)

## ⚡ Getting Started

The easiest way to run OpenDevin is to [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/OpenDevin/OpenDevin) but it is not the recommended usage path yet. For the best experience and optimal setup, please follow the docker method.

Copy link
Collaborator

@mamoodi mamoodi Jul 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is very confusing to be part of the main README. Especially because this won't be the recommended way of running OpenDevin.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, it looks strange to put a not recommend way at the beginning of main readme.

@tobitege tobitege requested a review from neubig July 17, 2024 16:24
@@ -45,6 +45,9 @@ OpenDevin agents collaborate with human developers to write code, fix bugs, and
![App screenshot](./docs/static/img/screenshot.png)

## ⚡ Getting Started

The easiest way to run OpenDevin is to [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new/OpenDevin/OpenDevin) but it is not the recommended usage path yet. For the best experience and optimal setup, please follow the docker method.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, it looks strange to put a not recommend way at the beginning of main readme.

@neubig
Copy link
Contributor

neubig commented Jul 18, 2024

Yes, let's close this for now, but we can revisit it in the future as necessary.

@neubig neubig closed this Jul 18, 2024
neubig added a commit that referenced this pull request Jul 28, 2024
* Workaround for GitHub Codespaces

* Add devcontainer config

* rename devcontainer folder

* install netcat

* add VS Code Python extension

* apt update

* give executable path to avoid bugs

* configure poetry env

* fix postCreateCommand

* revert executable path

* add postStartCommand

* run in background

* Add Codespaces badge

* add default config

* Add Codespaces badge to doc

* update comment

* apply workaround 2

* refactor

* fix lib path

* Update on_create.sh

* pass env directly to cmd

* resolve unexpected merge conflicts

* Separated to #2850

* Update README.md

Co-authored-by: Graham Neubig <neubig@gmail.com>

* Update codespaces link

* Update README.md

* Separated to #2975

---------

Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Graham Neubig <neubig@gmail.com>
@SmartManoj SmartManoj mentioned this pull request Jul 30, 2024
SmartManoj added a commit to SmartManoj/Kevin that referenced this pull request Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants