Streamline documentation for getting started #6335
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Mark evo.ninja as hackathon winner and new Current Best Agent * Remove hackathon banner
✅ Deploy Preview for auto-gpt-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
* Rewrite sections about Forge, Benchmark, UI, Agent Protocol * Add sections about Leaderboard and CLI
* Reduce link clutter
Pwuts
force-pushed
the
docs/streamline-getting-started
branch
from
4cd5b9b
to
39e6b77
Compare
- Added link to public kanban board for immediate priorities - Encouraged collaboration on bigger todo's - Removed section about net-negative PRs
- Added quick links to the README to improve user navigation. - Included links to the documentation, contributing guidelines, and quickstart guide for building your own Agent.
- Added quick links in the index to different sections and related pages - Modified the introduction in the AutoGPT Documentation - Updated the Forge section with new links and descriptions - Deduplicated Frontend README
- Reformat titles in the navbar of the docs site to improve readability and consistency.
- Updated the introduction section in the `get-started.md` file to make it less cringe-worthy and more professional.
- Removed the benchmark page and added a link to the README in the repository instead. - Fixed a broken link in the navigation bar. - Simplified the titles in the navigation bar.
- Fix link to AutoGPT agent readme in the index.md file. - Rename how-it-works.md to introduction.md in the AutoGPT directory. - Update the navigation in mkdocs.yml to reflect the changes. Note: This commit does not add any new features or fix any bugs, but it improves the documentation and organization.
- Removed introduction.md file as it is no longer needed - Updated AutoGPT Agent section in mkdocs.yml to disable the introduction page and provide a link to the README on GitHub
- Updated links to documentation and setup instructions - Removed outdated Twitter accounts section
Pwuts
force-pushed
the
docs/streamline-getting-started
branch
from
73a80fe
to
00f9d81
Compare
- Added Agent Protocol and UI features - Updated setup instructions and configuration options - Modified Quickstart section - Added instructions for running AutoGPT using the CLI - Added instructions for running AutoGPT using the Agent Protocol server - Added additional resources section for wiki, project board, and roadmap updates - Added a note about the project's growth and commitment to sustainable development
Pwuts
force-pushed
the
docs/streamline-getting-started
branch
from
00f9d81
to
eee16db
Compare
- Update the description of AutoGPT to mention "modern Large Language Models" instead of GPT-4
- Rename AutoGPT/Setups/Git-setup.md to AutoGPT/setup/Git-setup.md - Rename AutoGPT/Setups/Docker-setup.md to AutoGPT/setup/docker.md - Rename AutoGPT/setup.md to AutoGPT/setup/index.md - Rename AutoGPT/Setups/nogit-setup.md to AutoGPT/setup/nogit-setup.md - Update links in mkdocs.yml to reflect new structure
|
This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR. |
Pwuts
force-pushed
the
docs/streamline-getting-started
branch
from
c2b5bbb
to
605eb90
Compare
|
This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR. |
- Added index page with general information about the agent - Simplified and updated the agent's setup docs - Removed stuff about Azure support - Removed separate setup instructions for Git and Docker - Updated the agent user guide with new command line interface information - Added information about agent states and logs to agent user guide - Updated the site navigation to be consistent with the above changes
Pwuts
force-pushed
the
docs/streamline-getting-started
branch
from
605eb90
to
423a168
Compare
|
This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR. |
|
This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR. |
- Fix formatting issues in the usage.md file - Update the navbar in the mkdocs.yml file to remove the partially outdated configuration chapter and link to Readme
|
This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR. |
- Fixed links in the documentation index to point to the correct sections. - Updated link to the introduction of the Agent.
|
This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR. |
- Update document title from "Set up with Docker" to "Run AutoGPT in Docker" - Modify link text from "Set up with Docker" to "Set up & Run with Docker" - Modify link text from "Developer setup" to "For Developers"
|
This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR. |
- Updated the benchmark section on the homepage to provide clearer information and improve readability. - Updated the link to the benchmark's readme file to point to the correct location. - Added a description of the `agbenchmark` package on Pypi and its integration with the project's CLI. - Clarified the standardization of the agent protocol used by AutoGPT to ensure compatibility with various agents.
|
This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR. |
- Commented out the navigation items related to challenges in the mkdocs.yml file to hide the outdated chapter.
|
This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
Our docs are out of date, and the README + Quickstart + docs aren't optimally organized to streamline getting started for new users and onboarding for new contributors.
Changes 🏗️
README.mddocs.agpt.coCONTRIBUTING.mdautogpt/README.mdPR Quality Scorecard ✨
+2 pts+5 pts+5 pts+5 pts-4 pts+4 pts+5 pts-5 ptsagbenchmarkto verify that these changes do not regress performance?+10 pts