AutoGPT
AutoGPT copied to clipboard
README.md - Add Table Of Contents+Guide for Docker
Background
- There was no Table of Contents so I made one for reading the documentation more optimally
- There was no link that redirects on how to install Docker Engine - for people who just starting with Docker.
Changes
- Added a Table of Contents for easy navigation through the README.md.
- Included a new "Installing Docker" section with a link to the Official Docker Engine Installation Guide.
Documentation
For example the "Features" topic is written in the following way:
In the Table of contents:
[🚀 Features](#features)
And where the actual topic is located i added a link with the variable:
## <a name="features"></a>🚀 Features
Test Plan
- no tests needed, just document edits.
PR Quality Checklist
- [v] My pull request is atomic and focuses on a single change.
- [ ] I have thoroughly tested my changes with multiple different prompts. - no tests needed, just document edits.
- [ ] I have considered potential risks and mitigations for my changes. - no risk, just document edits.
- [v] I have documented my changes clearly and comprehensively.
- [v] I have not snuck in any "extra" small tweaks changes
This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.
We have now restructed the README into /docs (it was getting too long). Please resolve the conflicts/add your docker instructions into the right (new) place.
We have now restructed the README into /docs (it was getting too long). Please resolve the conflicts/add your docker instructions into the right (new) place.
Done
This has already been fixed. Thanks for submitting though!