docs(docs): start implementing docs website

.github/workflows/deploy-docs.yml

@@ -0,0 +1,53 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+ push:
+ branches:
+ - main
+
+jobs:
+ build:
+ name: Build Docusaurus
+ runs-on: ubuntu-latest
+ defaults:
+ run:
+ working-directory: docs
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ - uses: actions/setup-node@v4
+ with:
+ node-version: 18
+ cache: npm
+ cache-dependency-path: docs/package-lock.json
+
+ - name: Install dependencies
+ run: npm ci
+ - name: Build website
+ run: npm run build
+
+ - name: Upload Build Artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ path: build
+
+ deploy:
+ name: Deploy to GitHub Pages
+ needs: build
+ # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+ permissions:
+ pages: write # to deploy to Pages
+ id-token: write # to verify the deployment originates from an appropriate source
+ # Deploy to the github-pages environment
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: ubuntu-latest
+ defaults:
+ run:
+ working-directory: docs
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4

.github/workflows/test-deploy-docs.yml

@@ -0,0 +1,28 @@
+name: Test Deploy Docs to GitHub Pages
+
+on:
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ test-deploy:
+ name: Test deployment
+ runs-on: ubuntu-latest
+ defaults:
+ run:
+ working-directory: docs
+ steps:
+ - uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+ - uses: actions/setup-node@v4
+ with:
+ node-version: 18
+ cache: npm
+ cache-dependency-path: docs/package-lock.json
+
+ - name: Install dependencies
+ run: npm ci
+ - name: Test build website
+ run: npm run build

README.md

@@ -32,7 +32,7 @@
 
 <!-- PROJECT LOGO -->
 <div align="center">
- <img src="./logo.png" alt="Logo" width="200" height="200">
+ <img src="./docs/static/img/logo.png" alt="Logo" width="200" height="200">
  <h1 align="center">OpenDevin: Code Less, Make More</h1>
 </div>
 
@@ -63,7 +63,7 @@
 
 ## 🎯 Mission
 
-[Project Demo Video](https://github.com/OpenDevin/OpenDevin/assets/38853559/71a472cc-df34-430c-8b1d-4d7286c807c9)
+[Project Demo Video](./docs/static/img/teaser.mp4)
 
 Welcome to OpenDevin, an open-source project aiming to replicate Devin, an autonomous AI software engineer who 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.
 

dev_config/python/.pre-commit-config.yaml

@@ -11,7 +11,7 @@ repos:
  rev: 7.0.0
  hooks:
  - id: flake8
- args: ['--select=Q000']  # Q000 is the error code for single quote enforcement
+ args: ["--select=Q000"] # Q000 is the error code for single quote enforcement
  additional_dependencies:
  - flake8-quotes
 
@@ -34,18 +34,24 @@ repos:
  # Run the linter.
  - id: ruff
  entry: ruff check --config dev_config/python/ruff.toml opendevin/ agenthub/
- types_or: [ python, pyi, jupyter ]
- args: [ --fix ]
+ types_or: [python, pyi, jupyter]
+ args: [--fix]
  # Run the formatter.
  - id: ruff-format
  entry: ruff check --config dev_config/python/ruff.toml opendevin/ agenthub/
- types_or: [ python, pyi, jupyter ]
+ types_or: [python, pyi, jupyter]
 
  - repo: https://github.com/pre-commit/mirrors-mypy
  rev: v1.9.0
  hooks:
  - id: mypy
- additional_dependencies: [types-requests, types-setuptools, types-pyyaml, types-toml]
+ additional_dependencies:
+ [types-requests, types-setuptools, types-pyyaml, types-toml]
  entry: mypy --config-file dev_config/python/mypy.ini opendevin/ agenthub/
  always_run: true
  pass_filenames: false
+
+ - repo: https://github.com/NiklasRosenstein/pydoc-markdown
+ rev: develop
+ hooks:
+ - id: pydoc-markdown

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*