V3 maintenance] consolidate and document core changes in v3 #397
Conversation
WalkthroughThe update significantly restructures and enhances the Fiber documentation across various files, improving clarity and organization. It introduces new sections, updates method names, and aligns content with recent changes in the Fiber v3 release, ensuring users have the latest information for effective application development. Changes
Possibly related issues
Poem
Recent Review DetailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional comments not posted (2)
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 (
|
|
is only the first wave of changes, which will come later via gofiber/fiber#2934 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| ### Drop for old Go versions | ||
| ### App changes |
There was a problem hiding this comment.
Ensure that headings are surrounded by blank lines for proper markdown formatting.
+ 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.
| ### Drop for old Go versions | |
| ### App changes | |
| ### Drop for old Go versions | |
| ### App changes |
| ### Context change | ||
| #### interface |
There was a problem hiding this comment.
Ensure that headings are surrounded by blank lines for proper markdown formatting.
+ 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.
| ### Context change | |
| #### interface | |
| ### Context change | |
| #### interface | |
| - Listen functions reduced | ||
|
|
||
| ### Context change | ||
| #### interface |
There was a problem hiding this comment.
Remove trailing spaces to adhere to markdown best practices.
-#### interface
+#### interfaceCommittable 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.
| #### interface | |
| #### interface |
docs/core/api/fiber.md
Outdated
| This method creates a new **App** named instance. You can pass optional [config ](#config)when creating a new instance. | ||
| ### New | ||
|
|
||
| This method creates a new **App** named instance. You can pass optional [config](#config)when creating a new instance. |
There was a problem hiding this comment.
Ensure there is a space between "config" and "when" in the sentence.
- You can pass optional [config](#config)when creating a new instance.
+ You can pass optional [config](#config) when creating a new instance.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.
| This method creates a new **App** named instance. You can pass optional [config](#config)when creating a new instance. | |
| This method creates a new **App** named instance. You can pass optional [config](#config) when creating a new instance. |
docs/core/api/fiber.md
Outdated
| | CaseSensitive | `bool` | When enabled, `/Foo` and `/foo` are different routes. When disabled, `/Foo`and `/foo` are treated the same. | `false` | | ||
| | Property | Type | Description | Default | | ||
| |------------------------------|-------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------| | ||
| | AppName | `string` | This allows to setup app name for the app | `""` | |
There was a problem hiding this comment.
Correct the usage of "setup" to "set up" as it should be two words when used as a verb.
- This allows to setup app name for the app
+ This allows to set up app name for the appCommittable 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.
| | AppName | `string` | This allows to setup app name for the app | `""` | | |
| | AppName | `string` | This allows to set up app name for the app | `""` | |
docs/core/api/app.md
Outdated
| import RoutingHandler from './../partials/routing/handler.md'; | ||
|
|
||
| ## Static | ||
| ### Static | ||
|
|
||
| Use the **Static** method to serve static files such as **images**, **CSS,** and **JavaScript**. |
There was a problem hiding this comment.
Add a space after the comma in "images, CSS, and JavaScript" to maintain consistency in punctuation.
- images, **CSS,** and **JavaScript**.
+ images, **CSS**, and **JavaScript**.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.
| Use the **Static** method to serve static files such as **images**, **CSS,** and **JavaScript**. | |
| Use the **Static** method to serve static files such as **images**, **CSS**, and **JavaScript**. |
docs/core/api/fiber.md
Outdated
| | WriteTimeout | `time.Duration` | The maximum duration before timing out writes of the response. The default timeout is unlimited. | `nil` | | ||
| | XMLEncoder | `utils.XMLMarshal` | Allowing for flexibility in using another XML library for encoding. | `xml.Marshal` | | ||
|
|
||
|
|
There was a problem hiding this comment.
Remove extra blank lines to maintain consistency in document formatting.
-
-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.
docs/core/api/fiber.md
Outdated
| | OnShutdownSuccess | `func()` | Allows to customize success behavior when gracefully shutting down the server by given signal. | `nil` | | ||
| | TLSConfigFunc | `func(tlsConfig *tls.Config)` | Allows customizing `tls.Config` as you want. | `nil` | | ||
|
|
||
|
|
There was a problem hiding this comment.
Remove extra blank lines to maintain consistency in document formatting.
-
-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.
docs/core/api/app.md
Outdated
| @@ -109,11 +111,11 @@ | |||
| }) | |||
| ``` | |||
|
|
|||
| ## Route Handlers | |||
| ### Route Handlers | |||
There was a problem hiding this comment.
Tip
Codebase Verification
The review comment is correct in highlighting the need to ensure that the content linked through <RoutingHandler /> is up-to-date and relevant. However, the file docs/partials/routing/handler.md referenced in the documentation does not exist. This issue affects multiple documents within the repository, including docs/core/api/app.md and docs/core/guide/routing.md. It is recommended to check if the file has been moved or renamed and update the references accordingly, or restore the file if it was removed unintentionally.
Analysis chain
The "Route Handlers" section is introduced well with a clear heading. Ensure that the content linked through <RoutingHandler /> is up-to-date and relevant to the context of this section.
Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Verify that the content in 'RoutingHandler' is relevant and up-to-date
cat docs/partials/routing/handler.md
Length of output: 103
Script:
#!/bin/bash
# Search for any markdown files that might contain the content intended for `RoutingHandler` or similar documentation related to routing handlers.
fd '\.md$' docs/ --exec grep -H 'RoutingHandler' {}
Length of output: 313
docs/core/api/fiber.md
Outdated
| func (app *App) ShutdownWithContext(ctx context.Context) error | ||
| ``` | ||
|
|
||
|
|
There was a problem hiding this comment.
Remove extra blank lines to maintain consistency in document formatting.
-
-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.
|
|
||
| :::caution | ||
|
|
||
| Its a draft, not finished yet. |
There was a problem hiding this comment.
Correct the contraction in the caution note.
- Its a draft, not finished yet.
+ It's a draft, not finished yet.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.
| Its a draft, not finished yet. | |
| It's a draft, not finished yet. |
|
|
||
| We are excited to announce the release of Fiber v3! 🚀 | ||
|
|
||
| Fiber v3 is a major release with a lot of new features, improvements, and breaking changes. We have worked hard to make Fiber even faster, more flexible, and easier to use. |
There was a problem hiding this comment.
Consider rephrasing to avoid wordiness.
- Fiber v3 is a major release with a lot of new features, improvements, and breaking changes.
+ Fiber v3 is a major release packed with new features, improvements, and significant changes.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.
| Fiber v3 is a major release with a lot of new features, improvements, and breaking changes. We have worked hard to make Fiber even faster, more flexible, and easier to use. | |
| Fiber v3 is a major release packed with new features, improvements, and significant changes. We have worked hard to make Fiber even faster, more flexible, and easier to use. |
| ### Generic functions | ||
| ### Middleware refactoring | ||
| #### Session middleware | ||
| #### Filesystem middleware |
There was a problem hiding this comment.
Possible spelling mistake found.
- #### Filesystem middleware
+ #### File System MiddlewareCommittable 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.
| #### Filesystem middleware | |
| #### File System Middleware |
Summary by CodeRabbit