Update intro.md #3222
Update intro.md #3222
Conversation
Update it to install and with version.
firevenus
requested review from
gaby,
sixcolors,
ReneWerner87 and
efectn
and removed request for
a team
|
Thanks for opening this pull request! 🎉 Please check out our contributing guidelines. If you need help or want to chat with us, join us on Discord https://gofiber.io/discord |
WalkthroughThe documentation for the Fiber web framework has been updated to reflect a change in the installation command, shifting from Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration 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: 1
🧹 Outside diff range and nitpick comments (3)
docs/intro.md (3)
Line range hint
8-8: Update placeholder release dateThe documentation contains a placeholder for the v3 release date: "Month xx, 202x". This should be updated with the actual release date.
Line range hint
22-73: Excellent explanation of context value handlingThe Zero Allocation section provides clear guidance on context value handling, with good examples and references. Consider adding a warning box or visual highlight for the critical rule: "you must only use context values within the handler".
Consider adding a highlighted warning:
### Zero Allocation +> ⚠️ **Important**: Context values are only valid within handlers. Using them outside handlers can lead to data races and unexpected behavior. + Fiber is optimized for **high performance**...
Update installation command to use v3
The code examples consistently use v3 imports, but there's one inconsistency in the installation command that needs to be updated:
-go install github.com/gofiber/fiber/v2@latest +go install github.com/gofiber/fiber/v3@latest🔗 Analysis chain
Line range hint
75-186: Ensure version consistency in code examplesThe code examples need to be updated to consistently use v3 imports. Currently, there's a mix of versions in the examples.
Let's verify the version references in the code examples:
Update all import statements to use v3:
-import "github.com/gofiber/fiber/v2" +import "github.com/gofiber/fiber/v3"🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for version references in code blocks rg -U 'fiber/v[23]' docs/intro.mdLength of output: 152
Script:
#!/bin/bash # Let's search for any other potential version references in the entire file rg -U '(?:fiber/v\d|@v\d)' docs/intro.mdLength of output: 159
| @@ -17,7 +17,7 @@ First, [download](https://go.dev/dl/) and install Go. Version `1.22` or higher i | |||
| Installation is done using the [`go get`](https://pkg.go.dev/cmd/go/#hdr-Add_dependencies_to_current_module_and_install_them) command: | |||
|
|
|||
| ```bash | |||
| go get github.com/gofiber/fiber/v3 | |||
| go install github.com/gofiber/fiber/v2@latest | |||
There was a problem hiding this comment.
Critical version mismatch in installation instructions
The documentation header states "These docs are for Fiber v3", but the installation command references v2. This inconsistency could mislead users about which version they're installing.
If this is meant to be v3 documentation, update the command:
-go install github.com/gofiber/fiber/v2@latest
+go install github.com/gofiber/fiber/v3@latest📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| go install github.com/gofiber/fiber/v2@latest | |
| go install github.com/gofiber/fiber/v3@latest |
|
@firevenus The |
Update it to install and with version.
Description
Please provide a clear and concise description of the changes you've made and the problem they address. Include the purpose of the change, any relevant issues it solves, and the benefits it brings to the project. If this change introduces new features or adjustments, highlight them here.
Fixes # (issue)
Changes introduced
List the new features or adjustments introduced in this pull request. Provide details on benchmarks, documentation updates, changelog entries, and if applicable, the migration guide.
Type of change
Please delete options that are not relevant.
Checklist
Before you submit your pull request, please make sure you meet these requirements:
/docs/directory for Fiber's documentation.Commit formatting
Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md