Repository navigation
docs: polish the README with GitHub Markdown features - #3204
Merged
Merged
Conversation
Add a centered header with the Echo logo for light and dark themes, the tagline, badges and a link row including Echo Pro and commercial support. Rename the intro to About and add a Mermaid diagram of the request flow. Use alerts for the v4 maintenance note and vulnerability reporting, show the example's output, and fold the third-party middleware list into a collapsed section.
pkg.go.dev shows GitHub alerts as literal [!NOTE] text and does not render Mermaid. Use bold notes and a numbered request-flow list instead, and load the logos from absolute URLs so they show outside GitHub.
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.
Uses GitHub Markdown features the README did not use yet (docs):
<picture>, logos in.github/assets/from the website), tagline, badges and a link row including Echo Pro and commercial support.HTTPErrorHandler), checked againstserveHTTP.consoleblock;e.Startgraceful shutdown on Ctrl+C.<details>section.Reviewed by Codex; its one finding (Pre middleware errors in the diagram) is fixed.