Repository navigation
docs: refresh the v4 README for the maintenance line - #3202
Merged
Merged
Conversation
State that v4 is the maintenance line and link the v4 API reference and the v5 upgrade guide. Add a Support section with the support dates, the Go 1.26 requirement and Echo Support. Move upgrade notes to the top, link the client IP advisories, and add the v4.16.0 request-scheme change. Fix the example's missing errors import, point badges at the v4 branch, drop the retired Go Report Card badge, and update moved links.
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.
Rewrites the v4 README for the maintenance line.
API_CHANGES_V5.md) and the website (which documents v5).CHANGELOG.mdandSECURITY.mdstill works; both CVEs link to their advisories. Adds the v4.16.0 request-scheme change (HTTPSRedirectbehind a TLS-terminating public proxy needsEcho#SchemeExtractor).errorsimport and uses gofmt formatting. Both code samples compile against v4.oapi-codegen/oapi-codegen, standardlog/slog; typo fixes; contribution notes say v4 takes bug and security fixes only.Reviewed by an Opus reviewer (humanizer and diataxis skills) and by Codex; findings addressed. All links and badges return 200.
pkg.go.dev shows the README of the latest v4 tag, so this text appears there with the next v4 release.