AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.
Contributing to the Docs
We welcome contributions to our documentation! Our docs are hosted on GitBook and published from GitHub.
How It Works
- Documentation lives in the
docs/directory and changes like any other code: through a pull request todev - The published docs match
master. When a release reachesmaster, itsdocs/directory is copied to thegitbookbranch, and GitBook publishes that - The
gitbookbranch belongs to that copy. Don't open pull requests against it, and don't edit pages in GitBook: the next copy overwrites anything that isn't inmaster
Editing Docs Locally
Clone the repository and create a branch from
dev:git clone https://github.com/Significant-Gravitas/AutoGPT.git cd AutoGPT git checkout -b my-docs-change origin/devMake your changes to markdown files in
docs/Preview changes with any markdown preview tool
Adding a New Page
- Create a new markdown file in the appropriate
docs/subdirectory - Add the new page to the relevant
SUMMARY.mdfile to include it in the navigation - Submit a pull request to the
devbranch
Submitting a Pull Request
When you're ready to submit your changes, create a pull request targeting the dev branch. We will review your changes and merge them if appropriate. They appear on the published docs with the next release.