Fix docs (Significant-Gravitas#3336)

* Fix docs * Add short section about testing to contribution guide * Add back note for voice configuration * Remove LICENSE symlink from docs/ * Fix site_url in mkdocs.yml
Monoid-xLabs · Apr 26, 2023 · 76df14b · 76df14b
1 parent 109fa04
commit 76df14b
Show file tree

Hide file tree

Showing 14 changed files with 520 additions and 379 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,4 +1,4 @@
-# Code of Conduct for auto-gpt
+# Code of Conduct for Auto-GPT
 
 ## 1. Purpose
 
@@ -37,4 +37,3 @@ This Code of Conduct is adapted from the [Contributor Covenant](https://www.cont
 ## 6. Contact
 
 If you have any questions or concerns, please contact the project maintainers.
-
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,21 +4,11 @@ First of all, thank you for considering contributing to our project! We apprecia
 
 This document provides guidelines and best practices to help you contribute effectively.
 
-## Table of Contents
-
-- [Code of Conduct](#code-of-conduct)
-- [Getting Started](#getting-started)
-- [How to Contribute](#how-to-contribute)
-  - [Reporting Bugs](#reporting-bugs)
-  - [Suggesting Enhancements](#suggesting-enhancements)
-  - [Submitting Pull Requests](#submitting-pull-requests)
-- [Style Guidelines](#style-guidelines)
-  - [Code Formatting](#code-formatting)
-  - [Pre-Commit Hooks](#pre-commit-hooks)
-
 ## Code of Conduct
 
-By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md). Please read it to understand the expectations we have for everyone who contributes to this project.
+By participating in this project, you agree to abide by our [Code of Conduct]. Please read it to understand the expectations we have for everyone who contributes to this project.
+
+[Code of Conduct]: https://significant-gravitas.github.io/Auto-GPT/code-of-conduct.md
 
 ## 📢 A Quick Word
 Right now we will not be accepting any Contributions that add non-essential commands to Auto-GPT.
@@ -84,6 +74,7 @@ isort .
 ```
 
 ### Pre-Commit Hooks
+
 We use pre-commit hooks to ensure that code formatting and other checks are performed automatically before each commit. To set up pre-commit hooks for this project, follow these steps:
 
 Install the pre-commit package using pip:
@@ -103,7 +94,14 @@ If you encounter any issues or have questions, feel free to reach out to the mai
 Happy coding, and once again, thank you for your contributions!
 
 Maintainers will look at PR that have no merge conflicts when deciding what to add to the project. Make sure your PR shows up here:
+https://github.com/Significant-Gravitas/Auto-GPT/pulls?q=is%3Apr+is%3Aopen+-label%3Aconflicts
+
+## Testing your changes
+
+If you add or change code, make sure the updated code is covered by tests.
+
+To increase coverage if necessary, [write tests using `pytest`].
 
-https://github.com/Significant-Gravitas/Auto-GPT/pulls?q=is%3Apr+is%3Aopen+-is%3Aconflict+
+For more info on running tests, please refer to ["Running tests"](https://significant-gravitas.github.io/Auto-GPT/testing/).
 
-## Testing
+[write tests using `pytest`]: https://realpython.com/pytest-python-testing/
diff --git a/README.md b/README.md
@@ -89,28 +89,20 @@ Your support is greatly appreciated. Development of this free, open-source proje
 - 🗃️ File storage and summarization with GPT-3.5
 - 🔌 Extensibility with Plugins
 
-## 📋 Requirements
-
-Choose an environment to run Auto-GPT in (pick one):
-
-  - [Docker](https://docs.docker.com/get-docker/) (*recommended*)
-  - Python 3.10 or later (instructions: [for Windows](https://www.tutorialspoint.com/how-to-install-python-in-windows))
-  - [VSCode + devcontainer](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
-
 ## Quickstart
 
-1. Set up your OpenAI [API Keys](https://platform.openai.com/account/api-keys)
+1. Get an OpenAI [API Key](https://platform.openai.com/account/api-keys)
 2. Download the [latest release](https://github.com/Significant-Gravitas/Auto-GPT/releases/latest)
-3. Follow the [installation instructions][docs/install]
+3. Follow the [installation instructions][docs/setup]
 4. Configure any additional features you want, or install some [plugins][docs/plugins]
 5. [Run][docs/usage] the app
 
-Please see the [documentation][docs] linked below for full setup instructions and configuration options.
+Please see the [documentation][docs] for full setup instructions and configuration options.
 
 [docs]: https://significant-gravitas.github.io/Auto-GPT/
 
 ## 📖 Documentation
-* [⚙️ Installation][docs/install]
+* [⚙️ Setup][docs/setup]
 * [💻 Usage][docs/usage]
 * [🔌 Plugins][docs/plugins]
 * Configuration
@@ -119,7 +111,7 @@ Please see the [documentation][docs] linked below for full setup instructions an
   * [🗣️ Voice (TTS)](https://significant-gravitas.github.io/Auto-GPT/configuration/voice/)
   * [🖼️ Image Generation](https://significant-gravitas.github.io/Auto-GPT/configuration/imagegen/)
 
-[docs/install]: https://significant-gravitas.github.io/Auto-GPT/installation/
+[docs/setup]: https://significant-gravitas.github.io/Auto-GPT/setup/
 [docs/usage]: https://significant-gravitas.github.io/Auto-GPT/usage/
 [docs/plugins]: https://significant-gravitas.github.io/Auto-GPT/plugins/
 

diff --git a/docs/LICENSE b/docs/LICENSE
diff --git a/docs/configuration/imagegen.md b/docs/configuration/imagegen.md
@@ -1,14 +1,58 @@
-## 🖼 Image Generation
+# 🖼 Image Generation configuration
 
-By default, Auto-GPT uses DALL-e for image generation. To use Stable Diffusion, a [Hugging Face API Token](https://huggingface.co/settings/tokens) is required.
+| Config variable  | Values                          |                      |
+| ---------------- | ------------------------------- | -------------------- |
+| `IMAGE_PROVIDER` | `dalle` `huggingface` `sdwebui` | **default: `dalle`** |
 
-Once you have a token, set these variables in your `.env`:
+## DALL-e
 
+In `.env`, make sure `IMAGE_PROVIDER` is commented (or set to `dalle`):
+``` ini
+# IMAGE_PROVIDER=dalle    # this is the default
+```
+
+Further optional configuration:
+
+| Config variable  | Values             |                |
+| ---------------- | ------------------ | -------------- |
+| `IMAGE_SIZE`     | `256` `512` `1024` | default: `256` |
+
+## Hugging Face
+
+To use text-to-image models from Hugging Face, you need a Hugging Face API token.
+Link to the appropriate settings page: [Hugging Face > Settings > Tokens](https://huggingface.co/settings/tokens)
+
+Once you have an API token, uncomment and adjust these variables in your `.env`:
 ``` ini
 IMAGE_PROVIDER=huggingface
-HUGGINGFACE_API_TOKEN=YOUR_HUGGINGFACE_API_TOKEN
+HUGGINGFACE_API_TOKEN=your-huggingface-api-token
 ```
 
+Further optional configuration:
+
+| Config variable           | Values                 |                                          |
+| ------------------------- | ---------------------- | ---------------------------------------- |
+| `HUGGINGFACE_IMAGE_MODEL` | see [available models] | default: `CompVis/stable-diffusion-v1-4` |
+
+[available models]: https://huggingface.co/models?pipeline_tag=text-to-image
+
+## Stable Diffusion WebUI
+
+It is possible to use your own self-hosted Stable Diffusion WebUI with Auto-GPT:
+``` ini
+IMAGE_PROVIDER=sdwebui
+```
+
+!!! note
+    Make sure you are running WebUI with `--api` enabled.
+
+Further optional configuration:
+
+| Config variable | Values                  |                                  |
+| --------------- | ----------------------- | -------------------------------- |
+| `SD_WEBUI_URL`  | URL to your WebUI       | default: `http://127.0.0.1:7860` |
+| `SD_WEBUI_AUTH` | `{username}:{password}` | *Note: do not copy the braces!*  |
+
 ## Selenium
 ``` shell
 sudo Xvfb :10 -ac -screen 0 1024x768x24 & DISPLAY=:10 <YOUR_CLIENT>