Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Streamline documentation for getting started #6335

Merged
merged 24 commits into from
Nov 23, 2023

Conversation

Pwuts
Copy link
Member

@Pwuts Pwuts commented Nov 21, 2023

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.md

    • Mark evo.ninja as hackathon winner and new Current Best Agent.
    • Remove hackathon banner.
    • Rewrite sections about Forge, Benchmark, UI, Agent Protocol.
    • Add sections about Leaderboard and CLI.
    • Add quick links for improved user navigation, including links to documentation, contributing guidelines, and quickstart guide.
    • Remove Quickstart.
  • docs.agpt.co

    • Removed links to outdated pages from navbar.
    • Added quick links to several pages.
    • Refactored and updated titles in docs site navbar for better readability and consistency.
    • Make Forge intro more professional and less cringe-worthy.
    • Fix broken links.
    • Rewrote setup and usage guides for AutoGPT Agent.
    • Added page with general information about AutoGPT.
  • CONTRIBUTING.md

    • Make CONTRIBUTING.md more friendly and accessible: added link to public kanban board, encouraged collaboration, removed section about net-negative PRs.
  • autogpt/README.md

    • Update description of AutoGPT to mention "modern Large Language Models" instead of GPT-4.
    • Add quick links for improved user navigation, including links to documentation and contributing guidelines.
    • Add features and setup guide: Agent Protocol, UI features, setup instructions, configuration options, Quickstart, CLI instructions, Agent Protocol server instructions, additional resources (wiki, project board, roadmap), and a note on sustainable development.
    • Update links: documentation, setup instructions.
    • Remove outdated Twitter accounts section.

PR Quality Scorecard ✨

  • Have you used the PR description template?   +2 pts
  • Is your pull request atomic, focusing on a single change?   +5 pts
  • Have you linked the GitHub issue(s) that this PR addresses?   +5 pts
  • Have you documented your changes clearly and comprehensively?   +5 pts
  • Have you changed or added a feature?   -4 pts
    • Have you added/updated corresponding documentation?   +4 pts
    • Have you added/updated corresponding integration tests?   +5 pts
  • Have you changed the behavior of AutoGPT?   -5 pts
    • Have you also run agbenchmark to verify that these changes do not regress performance?   +10 pts

* Mark evo.ninja as hackathon winner and new Current Best Agent

* Remove hackathon banner
@Pwuts Pwuts added the documentation Improvements or additions to documentation label Nov 21, 2023
@Pwuts Pwuts added this to the Auto-GPT v0.5.0 milestone Nov 21, 2023
@Pwuts Pwuts marked this pull request as draft November 21, 2023 15:06
Copy link

netlify bot commented Nov 21, 2023

Deploy Preview for auto-gpt-docs ready!

Name Link
🔨 Latest commit 8057938
🔍 Latest deploy log https://app.netlify.com/sites/auto-gpt-docs/deploys/655f57dd0f329e00086fbd05
😎 Deploy Preview https://deploy-preview-6335--auto-gpt-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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
@github-actions github-actions bot added size/l and removed size/m labels Nov 22, 2023
@Pwuts Pwuts force-pushed the docs/streamline-getting-started branch from 4cd5b9b to 39e6b77 Compare November 22, 2023 14:24
- 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.
@Pwuts Pwuts requested a review from NeonN3mesis November 22, 2023 16:48
- 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 Pwuts force-pushed the docs/streamline-getting-started branch from 73a80fe to 00f9d81 Compare November 22, 2023 19:13
- 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 Pwuts force-pushed the docs/streamline-getting-started branch from 00f9d81 to eee16db Compare November 22, 2023 19:15
- Update the description of AutoGPT to mention "modern Large Language Models" instead of GPT-4
@Pwuts Pwuts marked this pull request as ready for review November 22, 2023 19:28
@Pwuts Pwuts requested a review from Swiftyos as a code owner November 22, 2023 19:28
- 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
@github-actions github-actions bot added size/xl and removed size/l labels Nov 23, 2023
Copy link
Contributor

This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR.

@Pwuts Pwuts force-pushed the docs/streamline-getting-started branch from c2b5bbb to 605eb90 Compare November 23, 2023 13:13
Copy link
Contributor

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 Pwuts force-pushed the docs/streamline-getting-started branch from 605eb90 to 423a168 Compare November 23, 2023 13:14
Copy link
Contributor

This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR.

Copy link
Contributor

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
Copy link
Contributor

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.
Copy link
Contributor

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"
Copy link
Contributor

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.
Copy link
Contributor

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.
Copy link
Contributor

This PR exceeds the recommended size of 500 lines. Please make sure you are NOT addressing multiple issues with one PR.

@Pwuts Pwuts merged commit 24008e8 into master Nov 23, 2023
11 of 16 checks passed
@Pwuts Pwuts deleted the docs/streamline-getting-started branch November 23, 2023 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/xl
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant