Updated codespaces and local documentation

dnuzzolillo · Jun 13, 2023 · 07eaac1 · 07eaac1
1 parent 73da1b2
commit 07eaac1
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 11 deletions.
diff --git a/website/docs/Installation Guide/gitcode.md b/website/docs/Installation Guide/gitcode.md
@@ -7,12 +7,23 @@
 2. Navigate to the directory and create a copy of `config_template.yaml` and name it `config.yaml`.
 3. Enter your unique OpenAI API Key, Google key, Custom search engine ID without any quotes or spaces in `config.yaml` file. Follow the links below to get your keys:
 
-|Keys|Accessing the keys|
-|--|--|
-|**OpenAI API Key**| Sign up and create an API key at [OpenAI Developer](https://beta.openai.com/signup/)|
-|**Google API key**| Create a project in the [Google Cloud Console](https://console.cloud.google.com/) and enable the API you need (for example: Google Custom Search JSON API). Then, create an API key in the "Credentials" section.|
-|**Custom search engine ID**| Visit [Google Programmable Search Engine](https://programmablesearchengine.google.com/about/) to create a custom search engine for your application and obtain the search engine ID.|
-
+#### OpenAI API Key
+  - Go to https://beta.openai.com/signup/ and click on your name on the Top-Right of the Screen. Click on "View API Keys".
+  - Click on "Create new secret key". 
+  - Enter a suitable name and click on "Create secret key".
+#### Google API key
+  - Go to [Google Cloud Console](https://console.cloud.google.com/). 
+  - Click on "Select Project".
+  - Click on "New Project".
+  - Choose a suitable name and create a new project.
+  - Go to "API and Services" from home page.
+  - Click on "Credentials" and then click on "Create Credentials" on the top. 
+  - Click on "API Key" and your API Key will be created.
+#### Custom Search Engine ID
+  - Register using your gmail id.
+  - Choose a suitable name and select "Search the entire web" and click on "Create".
+  - Click on "Customise" and copy the "Search Engine ID".
+
 5. Open up the terminal at the bottom of the codespace and run the following command: `docker compose up --build` and wait for the build to complete.
 6. Go to the 'Ports' tab, copy the 8001 and 3000 public addresses. Replace the `localhost` link in the `docker-compose.yaml` file with the 8001 public address, and paste the 3000 public address as a string into the `main.py` file.
 7. Make sure to remove the trailing forward slash from the end of URL in both places.

diff --git a/website/docs/Installation Guide/local.md b/website/docs/Installation Guide/local.md
@@ -11,11 +11,22 @@ sidebar_position: 1
 2. Navigate to the directory using `cd SuperAGI` and create a copy of `config_template.yaml` and name it `config.yaml`.
 3. Enter your unique OpenAI API Key, Google key, Custom search engine ID without any quotes or spaces in `config.yaml` file. Follow the links below to get your keys:
 
-|Keys|Accessing the keys|
-|--|--|
-|**OpenAI API Key**| Sign up and create an API key at [OpenAI Developer](https://beta.openai.com/signup/)|
-|**Google API key**| Create a project in the [Google Cloud Console](https://console.cloud.google.com/) and enable the API you need (for example: Google Custom Search JSON API). Then, create an API key in the "Credentials" section.|
-|**Custom search engine ID**| Visit [Google Programmable Search Engine](https://programmablesearchengine.google.com/about/) to create a custom search engine for your application and obtain the search engine ID.|
+#### OpenAI API Key
+  - Go to https://beta.openai.com/signup/ and click on your name on the Top-Right of the Screen. Click on "View API Keys".
+  - Click on "Create new secret key". 
+  - Enter a suitable name and click on "Create secret key".
+#### Google API key
+  - Go to [Google Cloud Console](https://console.cloud.google.com/). 
+  - Click on "Select Project".
+  - Click on "New Project".
+  - Choose a suitable name and create a new project.
+  - Go to "API and Services" from home page.
+  - Click on "Credentials" and then click on "Create Credentials" on the top. 
+  - Click on "API Key" and your API Key will be created.
+#### Custom Search Engine ID
+  - Register using your gmail id.
+  - Choose a suitable name and select "Search the entire web" and click on "Create".
+  - Click on "Customise" and copy the "Search Engine ID".
 
 4. Ensure that Docker is installed in your system, if not, Install it from [here](https://docs.docker.com/get-docker/). 
 5. Once you have Docker Desktop running, run command : `docker-compose up --build` in SuperAGI directory. Open your browser and go to `localhost:3000` to see SuperAGI running.