docs(readme): fix broken links and update Go version prerequisite#3461
Open
Napat wants to merge 2 commits into
Open
docs(readme): fix broken links and update Go version prerequisite#3461Napat wants to merge 2 commits into
Napat wants to merge 2 commits into
Conversation
- Fix the broken link for Auth Middleware to point to the correct URL `/advanced-guide/authentication` instead of `/advanced-guide/http-authentication`. - Add a hyperlink for Custom Middleware pointing to `/advanced-guide/middlewares`. - Update the Go version prerequisite from 1.24 to 1.26 to align with the strict toolchain requirement defined in `go.mod`.
This file contains hidden or 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
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.
/advanced-guide/authenticationinstead of/advanced-guide/http-authentication./advanced-guide/middlewares.go.mod.Pull Request Template
Description:
This pull request addresses three issues in the
README.mdto improve documentation accuracy and maintain alignment with the framework's configuration.Additional Information:
https://gofr.dev/docs/advanced-guide/http-authentication) was broken due to a directory restructuring. It has been updated to the correct active path:https://gofr.dev/docs/advanced-guide/authentication(aligning withdocs/navigation.js).https://gofr.dev/docs/advanced-guide/middlewares) to make the "Custom Middleware Support" text interactive and easy to access.README.mdpreviously stated that Go 1.24 or above is required. However, thego.modfile strictly specifiesgo 1.26.0. Under Go 1.21+ behavior, the Go compiler strictly enforces thegodirective ingo.modas a hard minimum. Therefore, the Go prerequisite inREADME.mdhas been updated to 1.26 to align with the framework's real build requirements.Checklist:
goimportandgolangci-lint.