-
Notifications
You must be signed in to change notification settings - Fork 45.8k
docs: add system requirements section to README #10054
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
docs: add system requirements section to README #10054
Conversation
This PR targets the Automatically setting the base branch to |
✅ Deploy Preview for auto-gpt-docs canceled.
|
@Bentlybro , this one is clean |
Here's the code health analysis summary for commits Analysis Summary
|
Thank you for adding the system requirements to the README.md. This is a valuable addition that will help users determine if their system is compatible with AutoGPT before installation. However, I noticed that this PR contains significant backend code changes that aren't related to the README documentation update:
These backend code changes aren't mentioned in your PR description, which only discusses README.md documentation changes. According to our contribution guidelines, all changes should be covered by the PR description, and maximum 20% of changes can be out of scope from the PR title. Please do one of the following:
Once addressed, this PR can be reconsidered for merging. |
Thank you for adding the system requirements to the README! This is a useful addition that will help users understand what they need before attempting to install AutoGPT. However, I noticed this PR includes several backend code changes that weren't mentioned in your PR description:
Since your PR title and description only mention README changes, these code modifications are unexpected. Could you please:
For option 1, you'll need to:
Looking forward to your updates! |
Thank you for adding the system requirements section to the README - this is a useful addition for users. However, I notice that this PR contains significant backend code changes that aren't mentioned in the PR title or description:
These backend changes need to be:
Please either:
Once the PR accurately represents the actual changes being made, we can proceed with the review. |
b1a9f47
to
96d973b
Compare
✅ Deploy Preview for auto-gpt-docs-dev canceled.
|
Thank you for adding the system requirements section to the README. This documentation addition will certainly help users understand what they need before attempting to install AutoGPT. However, I notice this PR includes substantial backend code changes that aren't mentioned in the title or description:
These backend changes appear unrelated to the README documentation update and make up the majority of the changes in this PR. To proceed, you should either:
The README changes look good on their own, but we need to address the scope mismatch with the backend changes before this can be merged. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this! it looks good to me.
@kcze , what's your take on this pull request, should I update anything there, or its okay for now? |
Hey this PR is ready to merge! |
This PR adds a comprehensive system requirements section to the README.md file. Currently, users don't have clear guidance on the hardware, software, and network requirements needed to run AutoGPT. This addition will help users determine if their system is capable of running AutoGPT before attempting installation.
Changes 🏗️
Checklist 📋
For code changes:
For configuration changes: