Fix docs alignment (#3302)

Significant-Gravitas · Apr 26, 2023 · f0f3403 · f0f3403 · vercel · Apr 26, 2023
1 parent d753793
commit f0f3403
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 54 deletions.
diff --git a/docs/configuration/search.md b/docs/configuration/search.md
@@ -5,11 +5,11 @@ This section is optional. use the official google api if you are having issues w
 To use the `google_official_search` command, you need to set up your Google API keys in your environment variables.
 
 Create your project:
+
 1. Go to the [Google Cloud Console](https://console.cloud.google.com/).
 2. If you don't already have an account, create one and log in.
 3. Create a new project by clicking on the "Select a Project" dropdown at the top of the page and clicking "New Project". 
-4. Give it a name and click "Create".
-
+4. Give it a name and click "Create". 
 Set up a custom search API and add to your .env file:
 5. Go to the [APIs & Services Dashboard](https://console.cloud.google.com/apis/dashboard).
 6. Click "Enable APIs and Services". 
@@ -21,7 +21,6 @@ Set up a custom search API and add to your .env file:
 12. Copy the API key.
 13. Set it as an environment variable named `GOOGLE_API_KEY` on your machine (see how to set up environment variables below).
 14. [Enable](https://console.developers.google.com/apis/api/customsearch.googleapis.com) the Custom Search API on your project. (Might need to wait few minutes to propagate)
-
 Set up a custom search engine and add to your .env file:
 15. Go to the [Custom Search Engine](https://cse.google.com/cse/all) page.
 16. Click "Add".

diff --git a/docs/installation.md b/docs/installation.md
@@ -2,11 +2,11 @@
 
 ## ⚠️ OpenAI API Keys Configuration
 
-Get your OpenAI API key from: https://platform.openai.com/account/api-keys.
+Get your OpenAI API key from: [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys).
 
 To use OpenAI API key for Auto-GPT, you **NEED** to have billing set up (AKA paid account).
 
-You can set up paid account at https://platform.openai.com/account/billing/overview.
+You can set up paid account at [https://platform.openai.com/account/billing/overview](https://platform.openai.com/account/billing/overview).
 
 Important: It's highly recommended that you track your usage on [the Usage page](https://platform.openai.com/account/usage).
 You can also set limits on how much you spend on [the Usage limits page](https://platform.openai.com/account/billing/limits).
@@ -19,19 +19,19 @@ You can also set limits on how much you spend on [the Usage limits page](https:/
 
 1. Make sure you have one of the environments listed under [**requirements**](../README.md#-requirements) set up.
 
-    _To execute the following commands, open a CMD, Bash, or Powershell window by navigating to a folder on your computer and typing `CMD` in the folder path at the top, then press enter._
+    _To execute the following commands, open a CMD, Bash, or Powershell window by navigating to a folder on your computer and typing `CMD` in the folder path at the top, then press enter.  Make sure you have [Git](https://git-scm.com/downloads) installed for your O/S._
 
 2. Clone the repository using Git, or download the [latest stable release](https://github.com/Significant-Gravitas/Auto-GPT/releases/latest) (`Source code (zip)`, at the bottom of the page).
 
-    ``` shell
+``` shell
     git clone -b stable https://github.com/Significant-Gravitas/Auto-GPT.git
-    ```
+```
 
 3. Navigate to the directory where you downloaded the repository.
 
-    ``` shell
+``` shell
     cd Auto-GPT
-    ```
+```
 
 5. Configure Auto-GPT:
    1. Find the file named `.env.template` in the main `Auto-GPT` folder. This file may be hidden by default in some operating systems due to the dot prefix. To reveal hidden files, follow the instructions for your specific operating system (e.g., in Windows, click on the "View" tab in File Explorer and check the "Hidden items" box; in macOS, press Cmd + Shift + .).
@@ -45,23 +45,24 @@ You can also set limits on how much you spend on [the Usage limits page](https:/
    You have now configured Auto-GPT.
 
    Notes:
+
    - See [OpenAI API Keys Configuration](#openai-api-keys-configuration) to get your OpenAI API key.
-   - Get your ElevenLabs API key from: https://elevenlabs.io. You can view your xi-api-key using the "Profile" tab on the website.
+   - Get your ElevenLabs API key from: [ElevenLabs](https://elevenlabs.io). You can view your xi-api-key using the "Profile" tab on the website.
    - If you want to use GPT on an Azure instance, set `USE_AZURE` to `True` and then follow these steps:
      - Rename `azure.yaml.template` to `azure.yaml` and provide the relevant `azure_api_base`, `azure_api_version` and all the deployment IDs for the relevant models in the `azure_model_map` section:
        - `fast_llm_model_deployment_id` - your gpt-3.5-turbo or gpt-4 deployment ID
        - `smart_llm_model_deployment_id` - your gpt-4 deployment ID
        - `embedding_model_deployment_id` - your text-embedding-ada-002 v2 deployment ID
 
-     - Please specify all of these values as double-quoted strings
-        ``` shell
-        # Replace string in angled brackets (<>) to your own ID
-        azure_model_map:
-            fast_llm_model_deployment_id: "<my-fast-llm-deployment-id>"
-            ...
-        ```
-     - Details can be found here: https://pypi.org/project/openai/ in the `Microsoft Azure Endpoints` section and here: https://learn.microsoft.com/en-us/azure/cognitive-services/openai/tutorials/embeddings?tabs=command-line for the embedding model.
-     - If you're on Windows you may need to install https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170
+``` shell
+# Please specify all of these values as double-quoted strings
+# Replace string in angled brackets (<>) to your own ID
+azure_model_map:
+    fast_llm_model_deployment_id: "<my-fast-llm-deployment-id>"
+        ...
+```
+Details can be found here: [https://pypi.org/project/openai/](https://pypi.org/project/openai/) in the `Microsoft Azure Endpoints` section and here: [learn.microsoft.com](https://learn.microsoft.com/en-us/azure/cognitive-services/openai/tutorials/embeddings?tabs=command-line) for the embedding model.
+If you're on Windows you may need to install [msvc-170](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)
 
 4. Follow the further instructions for running Auto-GPT with [Docker](#run-with-docker) (*recommended*), or [Docker-less](#run-docker-less)
 
@@ -100,9 +101,9 @@ docker run -it --env OPENAI_API_KEY='your-key-here' -v $PWD/ai_settings.yaml:/ap
 ```
 
 
-### Run Docker-less
+### Run without Docker
 
-Simply run `./run.sh` (Linux/macOS) or `.\run.bat` (Windows) in your terminal.
+Simply run `./run.sh` (Linux/macOS) or `.\run.bat` (Windows) in your terminal.  This will install any necessary Python packages and launch Auto-GPT.
 
 ### Run with Dev Container
 

diff --git a/docs/usage.md b/docs/usage.md
@@ -1,25 +1,33 @@
 # Usage
 
-1. Open a terminal and run the startup script:
-    * On Linux/MacOS:
-        ``` shell
-        ./run.sh
-        ```
-    * On Windows:
-        ``` shell
-        .\run.bat
-        ```
-    * Using Docker:
-        ``` shell
-        docker-compose run --rm auto-gpt
-        ```
-    Running with `--help` lists all the possible command line arguments you can pass:
-    ``` shell
-    ./run.sh --help
-
-    # or with docker
-    docker-compose run --rm auto-gpt --help
-    ```
+Open a terminal and run the startup script:
+
+- On Linux/MacOS:
+
+``` shell
+./run.sh
+```
+
+- On Windows:
+
+``` shell
+.\run.bat
+```
+
+- Using Docker:
+
+``` shell
+docker-compose run --rm auto-gpt
+```
+
+Running with `--help` lists all the possible command line arguments you can pass:
+
+``` shell
+./run.sh --help
+
+# or with docker
+docker-compose run --rm auto-gpt --help
+```
 
 2. After each response from Auto-GPT, choose from the options to authorize command(s),
 exit the program, or provide feedback to the AI.
@@ -34,17 +42,17 @@ Here are some common arguments you can use when running Auto-GPT:
 > Replace anything in angled brackets (<>) to a value you want to specify
 
 * View all available command line arguments
-    ``` shell
-    python -m autogpt --help
-    ```
+``` shell
+python -m autogpt --help
+```
 * Run Auto-GPT with a different AI Settings file
-    ``` shell
-    python -m autogpt --ai-settings <filename>
-    ```
+``` shell
+python -m autogpt --ai-settings <filename>
+```
 * Specify a memory backend
-    ``` shell
-    python -m autogpt --use-memory  <memory-backend>
-    ```
+``` shell
+python -m autogpt --use-memory  <memory-backend>
+```
 
 > **NOTE**: There are shorthands for some of these flags, for example `-m` for `--use-memory`. Use `python -m autogpt --help` for more information
 
@@ -65,9 +73,9 @@ Use at your own risk.
 
 1. Run the `autogpt` python module in your terminal:
 
-    ``` shell
-    python -m autogpt --continuous
-    ```
+``` shell
+python -m autogpt --continuous
+```
 
 2. To exit the program, press Ctrl + C