docs: fix README command and slog reference#2951
Closed
Bojun-Vvibe wants to merge 1 commit intolabstack:masterfrom
Closed
docs: fix README command and slog reference#2951Bojun-Vvibe wants to merge 1 commit intolabstack:masterfrom
Bojun-Vvibe wants to merge 1 commit intolabstack:masterfrom
Conversation
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
2 participants
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.
Repo: labstack/echo (⭐ 30000)
Type: docs
Files changed: 1
Lines: +3/-3
What
Updated
README.mdto fix three user-facing documentation issues: the installation snippet now uses a valid shell comment marker inside theshcode block, theslog-echoentry now links to the current standard-librarylog/slogpackage documentation instead of the retiredx/exp/slogpath, and the third-party middleware guidance sentence has a small grammar correction.Why
These changes remove small but real sources of friction in the first-touch documentation. The
//line inside a shell block is misleading if copied verbatim, and the outdatedsloglink points readers at a pre-standard-library package path. The grammar fix keeps contributor-facing guidance polished without changing behavior.Testing
No code tests were run because this is a README-only change. Verification was done by inspecting the rendered diff and ensuring the updated commands and links are syntactically correct.
Risk
Low / Documentation-only change with no runtime impact.