mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-01-09 15:17:59 -05:00
b9551db516
* docs updates * text changes * resolving merge conflicts --------- Co-authored-by: Kaitlyn Barnard <kaitlynbarnard@Kaitlyns-MacBook-Pro-2.local> Co-authored-by: Toran Bruce Richards <toran.richards@gmail.com>
1.2 KiB
1.2 KiB
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.txtor
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/contentdirectory. - Add the new page to the
navsection in themkdocs.ymlfile. - Add the content to the new markdown file.
- Run
mkdocs serveto 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.