AutoGPT
AutoGPT copied to clipboard
Significant-Gravitas
Mkdocs from auto doc
Background
Documentation is not fun to make, but is incredibly helpful for projects with a lot of contribution and use. This PR is a mkdocs, read the docs style 'doc as code' site that can house the documentation for the site. People inundating the discord with questions? Knock much of it out by pointing to good docs.
Changes
Added a docs folder with md files overviewing and providing examples for all for all of the python files in the scripts folder. Added a mkdocs yaml Added two requirements to the requirements.txt
Documentation
So the whole purpose of this is to provide a read the docs style site with loads of examples.
Test Plan
mkdocs has been and built on my pc.
PR Quality Checklist
- [x] My pull request is atomic and focuses on a single change.
- [NA] I have thouroughly tested my changes with multiple different prompts.
- [x] I have considered potential risks and mitigations for my changes.
- [x] I have documented my changes clearly and comprehensively.
- [x] I have not snuck in any "extra" small tweaks changes
The tests for mkdocs are maintained in their library and no additional/ functional 'code' has been added to the repo. The only addition is a mkdocs style docs folder with markdown, no functional impact to users, but will allow for collaborative documentation editing.
This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.
This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.
Conflicts have been resolved! 🎉 A maintainer will review the pull request shortly.
This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.
This is a mass message from the AutoGPT core team. Our apologies for the ongoing delay in processing PRs. This is because we are re-architecting the AutoGPT core!
For more details (and for infor on joining our Discord), please refer to: https://github.com/Significant-Gravitas/Auto-GPT/wiki/Architecting
