Fix(docs) requirements link in installation guide #3264
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
I want to say thank you for the incredible work the AutoGPT library creators have done. I encountered a broken link while reviewing the documentation for Auto-GPT installation at https://significant-gravitas.github.io/Auto-GPT/installation/. Upon further investigation, I can confirm that the issue is caused by a relative URL that leads to an incorrect destination, specifically https://significant-gravitas.github.io/Auto-GPT/README.md#-requirements. To address this issue, I have taken the necessary steps to modify the requirements URL from a relative to an absolute link, in order to ensure that it points to the correct location.
5 tasks
|
That's a lot of explanation for such a small change. Thanks :) |
Pwuts
approved these changes
Apr 26, 2023
Pwuts
changed the title
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.
I want to say thank you for the incredible work the AutoGPT library creators have done. I encountered a broken link while reviewing the documentation for Auto-GPT installation at https://significant-gravitas.github.io/Auto-GPT/installation/. Upon further investigation, I can confirm that the issue is caused by a relative URL that leads to an incorrect destination, specifically https://significant-gravitas.github.io/Auto-GPT/README.md#-requirements.
To address this issue, I have taken the necessary steps to modify the requirements URL from a relative to an absolute link, in order to ensure that it points to the correct location. I considered adding the complete link https://github.com/Significant-Gravitas/Auto-GPT/blob/master/README.md#-requirements but considering the sustainability and best code practices added https://github.com/Significant-Gravitas/Auto-GPT#-requirements.
@Significant-Gravitas - Please let me know if I can improve or if I have missed any community guidelines in making the edit? Thank you again for your hard work and dedication to the open source community.
Background
While going through the documentation for installation, I was taken to a 404 link when looking for requirements in the "General Setup".
Changes
The change makes sure the link is working in the repository and in the documentation. Therefore the requirements link has been changed from relative to absolute.
Documentation
The change is reflected in the installation documentation.
Test Plan
You can check the link in https://significant-gravitas.github.io/Auto-GPT/installation/ in "General Setup" point 1.
PR Quality Checklist