Add zero-allocation section to README #3039
Conversation
gaby
requested review from
sixcolors,
ReneWerner87 and
efectn
and removed request for
a team
WalkthroughThis update enhances the Fiber web framework's README documentation to emphasize zero memory allocation and streamline versioning references. A new "Zero Allocation" section has been introduced to highlight this feature. Additionally, the introduction section of the Fiber framework's documentation was updated to clarify the mutable nature of Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
docs/intro.md (2)
Line range hint
57-152: Replace hard tabs with spaces to maintain consistency and adhere to Markdown best practices.
Line range hint
118-118: Replace emphasis (italic) with actual headings for better structure and readability.- **Hello, World!** + ### Hello, World! - **Basic routing** + ### Basic routing - **Static files** + ### Static files - **Note** + ### NoteAlso applies to: 127-127, 138-138, 152-152
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .github/README.md (3 hunks)
- docs/intro.md (1 hunks)
Files skipped from review due to trivial changes (1)
- .github/README.md
Additional context used
LanguageTool
docs/intro.md
[style] ~14-~14: Often, this adverbial phrase is redundant. Consider using an alternative. (FIRST_OF_ALL)
Context: ... March XX, 2024. ### Installation First of all, download and ins...
Markdownlint
docs/intro.md
57-57: Column: 1 (MD010, no-hard-tabs)
Hard tabs
58-58: Column: 1 (MD010, no-hard-tabs)
Hard tabs
60-60: Column: 1 (MD010, no-hard-tabs)
Hard tabs
68-68: Column: 1 (MD010, no-hard-tabs)
Hard tabs
84-84: Column: 1 (MD010, no-hard-tabs)
Hard tabs
86-86: Column: 1 (MD010, no-hard-tabs)
Hard tabs
87-87: Column: 1 (MD010, no-hard-tabs)
Hard tabs
88-88: Column: 1 (MD010, no-hard-tabs)
Hard tabs
90-90: Column: 1 (MD010, no-hard-tabs)
Hard tabs
123-123: Column: 1 (MD010, no-hard-tabs)
Hard tabs
133-133: Column: 1 (MD010, no-hard-tabs)
Hard tabs
134-134: Column: 1 (MD010, no-hard-tabs)
Hard tabs
144-144: Column: 1 (MD010, no-hard-tabs)
Hard tabs
145-145: Column: 1 (MD010, no-hard-tabs)
Hard tabs
146-146: Column: 1 (MD010, no-hard-tabs)
Hard tabs
147-147: Column: 1 (MD010, no-hard-tabs)
Hard tabs
148-148: Column: 1 (MD010, no-hard-tabs)
Hard tabs
158-158: Column: 1 (MD010, no-hard-tabs)
Hard tabs
159-159: Column: 1 (MD010, no-hard-tabs)
Hard tabs
118-118: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
127-127: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
138-138: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
152-152: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
Additional comments not posted (1)
docs/intro.md (1)
25-25: Consider replacing "First of all," with a more direct introduction to improve clarity and conciseness.- First of all, [download](https://go.dev/dl/) and install Go. + To start, [download](https://go.dev/dl/) and install Go.Likely invalid or redundant comment.
Description
Update README to mention the
Zero Allocationaspect of Fiber. Add LINK to documentation for further explanation. Update the wording in the "intro.md" section of the Docs.Changes introduced
Type of change