aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar Reinier van der Leer <pwuts@agpt.co> 2023-11-24 15:45:48 +0100
committerGravatar Reinier van der Leer <pwuts@agpt.co> 2023-11-24 15:45:54 +0100
commit58341a939625a230f0526366960fc4ce77e9dc4e (patch)
tree59491ec66cba742c6094e815505c4cdf9ca593f1 /docs
parentdocs: Add mention of path to agent user guide (diff)
downloadAuto-GPT-58341a939625a230f0526366960fc4ce77e9dc4e.tar.gz
Auto-GPT-58341a939625a230f0526366960fc4ce77e9dc4e.tar.bz2
Auto-GPT-58341a939625a230f0526366960fc4ce77e9dc4e.zip
docs: Fix small errors and markup issues in documentation
- Updated the link to OpenAI API key page in the setup guide - Fixed formatting issues in the usage guide - Updated the link to the `.env.template` file in the usage guide - Fixed formatting and wording issues in the index page
Diffstat (limited to 'docs')
-rw-r--r--docs/content/AutoGPT/setup/index.md7
-rw-r--r--docs/content/AutoGPT/usage.md7
-rw-r--r--docs/content/index.md8
3 files changed, 12 insertions, 10 deletions
diff --git a/docs/content/AutoGPT/setup/index.md b/docs/content/AutoGPT/setup/index.md
index 4b3e24130..4b18f074c 100644
--- a/docs/content/AutoGPT/setup/index.md
+++ b/docs/content/AutoGPT/setup/index.md
@@ -30,7 +30,8 @@
### 🗝️ Getting an OpenAI API key
-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).
!!! attention
To use the OpenAI API with AutoGPT, we strongly recommend **setting up billing**
@@ -72,12 +73,12 @@ Since we don't ship AutoGPT as a desktop application, you'll need to download th
Once you have cloned or downloaded the project, you can find the AutoGPT Agent in the
`autogpts/autogpt/` folder. In this folder:
-1. Find the file named `.env.template` in the main `Auto-GPT` folder. This file may
+1. Find the file named `.env.template`. 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:
[Windows][show hidden files/Windows] and [macOS][show hidden files/macOS].
2. Create a copy of `.env.template` and call it `.env`;
- if you're already in a command prompt/terminal window:
+ if you're already in a command prompt/terminal window:
```shell
cp .env.template .env
```
diff --git a/docs/content/AutoGPT/usage.md b/docs/content/AutoGPT/usage.md
index ef654528d..dd6207a1a 100644
--- a/docs/content/AutoGPT/usage.md
+++ b/docs/content/AutoGPT/usage.md
@@ -152,8 +152,8 @@ For more information about the API of the application, see [agentprotocol.ai](ht
### Arguments
!!! attention
- Most arguments are equivalent to configuration options. See [`.env.template`] for
- all available configuration options.
+ Most arguments are equivalent to configuration options. See [`.env.template`][.env.template]
+ for all available configuration options.
!!! note
Replace anything in angled brackets (<>) to a value you want to specify
@@ -176,13 +176,14 @@ Here are some common arguments you can use when running AutoGPT:
There are shorthands for some of these flags, for example `-P` for `--prompt-settings`.
Use `./run.sh --help` for more information.
-[`.env.template`]: https://github.com/Significant-Gravitas/AutoGPT/tree/docs/streamline-getting-started/autogpts/autogpt/.env.template
+[.env.template]: https://github.com/Significant-Gravitas/AutoGPT/tree/master/autogpts/autogpt/.env.template
## Agent State
[agent state]: #agent-state
The state of individual agents is stored in the `data/agents` folder. You can use this
in various ways:
+
* Resume your agent at a later time.
* Create "checkpoints" for your agent so you can always go back to specific points in
its history.
diff --git a/docs/content/index.md b/docs/content/index.md
index 856a34f7c..6898da36f 100644
--- a/docs/content/index.md
+++ b/docs/content/index.md
@@ -4,10 +4,10 @@ Welcome to the AutoGPT Documentation.
The AutoGPT project consists of four main components:
-* The [Agent](#-agent) &ndash; also known as just "AutoGPT"
-* The [Benchmark](#-benchmark) &ndash; AKA `agbenchmark`
-* The [Forge](#-forge)
-* The [Frontend](#-frontend)
+* The [Agent](#agent) &ndash; also known as just "AutoGPT"
+* The [Benchmark](#benchmark) &ndash; AKA `agbenchmark`
+* The [Forge](#forge)
+* The [Frontend](#frontend)
To tie these together, we also have a CLI at the root of the project.