mirror of https://github.com/Significant-Gravitas/AutoGPT.git synced 2026-02-04 03:45:12 -05:00

Files

Nicholas Tindle 5e89b8c6d1 Add all the new component docs to the site and do a tidy up of docs (#7098 )

* feat: add all the new component docs to the site

* fix(docs): relative links and markdown warnings

* feat(docs): How to contribute to the docs as a docs section

* fix(docs): missed docs page for developer setup

* fix(docs): re-add configurations options

* fix(docs): bad link to components fixed

* fix(docs): bad link to components fixed

* ref(docs): reorder some items to make more sense

* fix(docs): bad indentation and duplicate block

* fix(docs): warning about out of date markdown extension

* fix(docs): broken links fixed

* fix(docs): markdown formatter complaints

2024-04-23 08:49:07 -05:00

1.2 KiB

Raw Blame History

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

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 the mkdocs.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.

1.2 KiB Raw Blame History