Contributing to the Docs¶
We welcome contributions to our documentation! If you would like to contribute, please follow the steps below.
Setting up the Docs¶
-
Clone the repository:
git clone github.com/Significant-Gravitas/AutoGPT.git
-
Install the dependencies:
python -m pip install -r docs/requirements.txt
or
python3 -m pip install -r docs/requirements.txt
-
Start iterating using mkdocs' live server:
mkdocs serve
-
Open your browser and navigate to
http://127.0.0.1:8000
. -
The server will automatically reload the docs when you save your changes.
Adding a new page¶
- Create a new markdown file in the
docs/content
directory. - Add the new page to the
nav
section in themkdocs.yml
file. - Add the content to the new markdown file.
- Run
mkdocs serve
to see your changes.
Checking links¶
To check for broken links in the documentation, run mkdocs build
and look for warnings in the console output.
Submitting a Pull Request¶
When you're ready to submit your changes, please create a pull request. We will review your changes and merge them if they are appropriate.