github/AutoGPT
1
1
Fork 0
mirror of https://github.com/Significant-Gravitas/AutoGPT.git synced 2026-01-09 15:17:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: Streamline documentation for getting started (#6335)

Browse Source 
* 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.
  - Rewrite intros on homepage to be more clear and professional and less cringe-worthy.
  - Fix broken links.
  - Rewrote setup and usage guides for AutoGPT Agent.
    - Removed mentions of Azure support, except in the Docker guide.
  - 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.
This commit is contained in:
Reinier van der Leer
2023-11-23 14:59:17 +01:00
committed by GitHub
parent 84afbf6b45
commit 24008e8741
18 changed files with 578 additions and 508 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
CONTRIBUTING.md
View File

@@ -2,36 +2,33 @@
If you are reading this, you are probably looking for our **[contribution guide]**,
which is part of our [knowledge base].
You can find our immediate priorities and their progress on our public [kanban board].
[contribution guide]: https://github.com/Significant-Gravitas/Nexus/wiki/Contributing
[knowledge base]: https://github.com/Significant-Gravitas/Nexus/wiki
[kanban board]: https://github.com/orgs/Significant-Gravitas/projects/1
## In short
1. Avoid duplicate work, issues, PRs etc.
2. Also consider contributing something other than code; see the [contribution guide]
for options.
3. Create a draft PR before starting work on non-small changes. Also post your proposal
in the [dev channel].
4. Clearly explain your changes when submitting a PR.
5. Don't submit stuff that's broken.
6. Avoid making unnecessary changes, especially if they're purely based on your personal
preferences. Doing so is the maintainers' job.
2. We encourage you to collaborate with fellow community members on some of our bigger
[todo's][kanban board]!
* We highly recommend to post your idea and discuss it in the [dev channel].
4. Create a draft PR when starting work on bigger changes.
3. Please also consider contributing something other than code; see the
[contribution guide] for options.
5. Clearly explain your changes when submitting a PR.
6. Don't submit stuff that's broken.
7. Avoid making unnecessary changes, especially if they're purely based on your personal
preferences. Doing so is the maintainers' job. ;-)
[dev channel]: https://discord.com/channels/1092243196446249134/1095817829405704305
## Why instructions like these are necessary
We would like to say "We value all contributions". After all, we are an open-source
project, so we should welcome any input that people are willing to give, right?
Well, the reality is that some contributions are SUPER-valuable, while others create
more trouble than they are worth and actually _create_ work for the core team. So to
ensure maximum chances of a smooth ride, please stick to the guidelines.
If you wish to involve with the project (beyond just contributing PRs), please read the
wiki [catalyzing](https://github.com/Significant-Gravitas/Nexus/wiki/Catalyzing) page.
In fact, why not just look through the whole wiki (it's only a few pages) and
hop on our Discord. See you there! :-)
❤️ & 🔆
The team @ AutoGPT
❤️ & 🔆
The team @ AutoGPT
https://discord.gg/autogpt