📒 docs: Full audit of documentation (#3717)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: gaby

docs/addon/retry.md

@@ -4,15 +4,13 @@ id: retry
 
 # Retry Addon
 
-Retry addon for [Fiber](https://github.com/gofiber/fiber) designed to apply retry mechanism for unsuccessful network
-operations. This addon uses an exponential backoff algorithm with jitter. It calls the function multiple times and tries
-to make it successful. If all calls are failed, then, it returns an error. It adds a jitter at each retry step because adding
-a jitter is a way to break synchronization across the client and avoid collision.
+The Retry addon for [Fiber](https://github.com/gofiber/fiber) retries failed network operations using exponential
+backoff with jitter. It repeatedly invokes a function until it succeeds or the maximum number of attempts is
+exhausted. Jitter at each step breaks client synchronization and helps avoid collisions. If all attempts fail, the
+addon returns an error.
 
 ## Table of Contents
 
-- [Retry Addon](#retry-addon)
-- [Table of Contents](#table-of-contents)
 - [Signatures](#signatures)
 - [Examples](#examples)
 - [Default Config](#default-config)
@@ -41,19 +39,19 @@ import (
 func main() {
     expBackoff := retry.NewExponentialBackoff(retry.Config{})
 
-    // Local variables that will be used inside of Retry
+    // Local variables used inside Retry
     var resp *client.Response
     var err error
 
-    // Retry a network request and return an error to signify to try again
+    // Retry a network request and return an error to signal another attempt
     err = expBackoff.Retry(func() error {
         client := client.New()
         resp, err = client.Get("https://gofiber.io")
         if err != nil {
             return fmt.Errorf("GET gofiber.io failed: %w", err)
         }
         if resp.StatusCode() != 200 {
-            return fmt.Errorf("GET gofiber.io did not return OK 200")
+            return fmt.Errorf("GET gofiber.io did not return 200 OK")
         }
         return nil
     })

docs/api/app.md

@@ -1,7 +1,7 @@
 ---
 id: app
 title: 🚀 App
-description: The app instance conventionally denotes the Fiber application.
+description: The `App` type represents your Fiber application.
 sidebar_position: 2
 ---
 
@@ -35,7 +35,7 @@ import RoutingHandler from './../partials/routing/handler.md';
 
 ### Mounting
 
-You can mount a Fiber instance using the [`app.Use`](./app.md#use) method, similar to [`Express`](https://expressjs.com/en/api.html#router.use).
+Mount another Fiber instance with [`app.Use`](./app.md#use), similar to Express's [`router.use`](https://expressjs.com/en/api.html#router.use).
 
 ```go title="Example"
 package main
@@ -219,15 +219,15 @@ func main() {
 
 ### HandlersCount
 
-This method returns the number of registered handlers.
+Returns the number of registered handlers.
 
 ```go title="Signature"
 func (app *App) HandlersCount() uint32
 ```
 
 ### Stack
 
-This method returns the original router stack.
+Returns the underlying router stack.
 
 ```go title="Signature"
 func (app *App) Stack() [][]*Route

docs/api/bind.md

@@ -6,11 +6,11 @@ sidebar_position: 4
 toc_max_heading_level: 4
 ---
 
-Bindings are used to parse the request/response body, query parameters, cookies, and much more into a struct.
+Bindings parse request and response bodies, query parameters, cookies, and more into structs.
 
 :::info
-All binder returned values are only valid within the handler. Do not store any references.  
-Make copies or use the [**`Immutable`**](./ctx.md) setting instead. [Read more...](../#zero-allocation)
+Binder-returned values are valid only within the handler. To keep them, copy the data
+or enable the [**`Immutable`**](./ctx.md) setting. [Read more...](../#zero-allocation)
 :::
 
 ## Binders
@@ -30,7 +30,7 @@ Make copies or use the [**`Immutable`**](./ctx.md) setting instead. [Read more..
 
 ### All
 
-The `All` function binds data from various sources (URL parameters, request body, query parameters, headers, and cookies) into the provided struct pointer `out`. It processes each source in a predefined order, applying data to the struct fields based on their tags.
+The `All` function binds data from URL parameters, the request body, query parameters, headers, and cookies into `out`. Sources are applied in the following order using struct field tags.
 
 #### Precedence Order
 
@@ -71,7 +71,7 @@ app.Post("/users", func(c fiber.Ctx) error {
 
 Binds the request body to a struct.
 
-It is important to specify the correct struct tag based on the content type to be parsed. For example, if you want to parse a JSON body with a field called `Pass`, you would use a struct field with `json:"pass"`.
+Use tags that match the content type. For example, to parse a JSON body with a `Pass` field, declare `json:"pass"`.
 
 | Content-Type                        | Struct Tag |
 | ----------------------------------- | ---------- |
@@ -106,7 +106,7 @@ app.Post("/", func(c fiber.Ctx) error {
 })
 ```
 
-Run tests with the following `curl` commands:
+Test the handler with these `curl` commands:
 
 ```bash
 # JSON
@@ -158,7 +158,7 @@ app.Post("/", func(c fiber.Ctx) error {
 })
 ```
 
-Run tests with the following `curl` command:
+Test the defaults with this `curl` command:
 
 ```bash
 curl -X POST -H "Content-Type: application/cbor" --data "\xa2dnamedjohndpasscdoe" localhost:3000

docs/api/constants.md

@@ -1,11 +1,11 @@
 ---
 id: constants
 title: 📋 Constants
-description: Some constants for Fiber.
+description: Core HTTP constants used throughout Fiber.
 sidebar_position: 10
 ---
 
-### HTTP methods were copied from net/http
+### HTTP methods (mirrors `net/http`)
 
 ```go
 const (
@@ -22,7 +22,7 @@ const (
 )
 ```
 
-### MIME types that are commonly used
+### Common MIME types
 
 ```go
 const (
@@ -48,7 +48,7 @@ const (
 )
 ```
 
-### HTTP status codes were copied from net/http
+### HTTP status codes (mirrors `net/http`)
 
 ```go
 const (

docs/api/ctx.md

@@ -24,10 +24,9 @@ app.Get("/stack", func(c fiber.Ctx) error {
 
 ### Bind
 
-Bind is a method that supports bindings for the request/response body, query parameters, URL parameters, cookies, and much more.
-It returns a pointer to the [Bind](./bind.md) struct which contains all the methods to bind the request/response data.
+Bind returns a helper for decoding the request body, query string, headers, cookies, and more.
 
-For detailed information, check the [Bind](./bind.md) documentation.
+For full details, see the [Bind](./bind.md) documentation.
 
 ```go title="Signature"
 func (c fiber.Ctx) Bind() *Bind
@@ -97,14 +96,14 @@ app.Get("/", func(c fiber.Ctx) error {
 
 ### GetReqHeaders
 
-Returns the HTTP request headers as a map. Since a header can be set multiple times in a single request, the values of the map are slices of strings containing all the different values of the header.
+Returns the HTTP request headers as a map. Because a header can appear multiple times in a request, each key maps to a slice with all values for that header.
 
 ```go title="Signature"
 func (c fiber.Ctx) GetReqHeaders() map[string][]string
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::
 
@@ -130,7 +129,7 @@ app.Get("/", func(c fiber.Ctx) error {
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::
 
@@ -143,7 +142,7 @@ func (c fiber.Ctx) GetRespHeaders() map[string][]string
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::
 
@@ -174,7 +173,7 @@ app.Get("/test", func(c fiber.Ctx) error {
 
 ### Locals
 
-A method that stores variables scoped to the request and, therefore, are available only to the routes that match the request. The stored variables are removed after the request is handled. If any of the stored data implements the `io.Closer` interface, its `Close` method will be called before it's removed.
+Stores variables scoped to the request, making them available only to matching routes. The variables are removed after the request completes. If a stored value implements `io.Closer`, Fiber calls its `Close` method before removal.
 
 :::tip
 This is useful if you want to pass some **specific** data to the next middleware. Remember to perform type assertions when retrieving the data to ensure it is of the expected type. You can also use a non-exported type as a key to avoid collisions.
@@ -565,7 +564,7 @@ app.Post("/", func(c fiber.Ctx) error {
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::
 
@@ -587,14 +586,14 @@ app.Post("/", func(c fiber.Ctx) error {
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::
 
 ### ClientHelloInfo
 
-`ClientHelloInfo` contains information from a ClientHello message in order to guide application logic in the `GetCertificate` and `GetConfigForClient` callbacks.
-You can refer to the [ClientHelloInfo](https://golang.org/pkg/crypto/tls/#ClientHelloInfo) struct documentation for more information on the returned struct.
+`ClientHelloInfo` contains information from a ClientHello message to guide application logic in the `GetCertificate` and `GetConfigForClient` callbacks.
+Refer to the [ClientHelloInfo](https://golang.org/pkg/crypto/tls/#ClientHelloInfo) struct documentation for details on the returned struct.
 
 ```go title="Signature"
 func (c fiber.Ctx) ClientHelloInfo() *tls.ClientHelloInfo
@@ -626,7 +625,7 @@ app.Get("/", func(c fiber.Ctx) error {
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.
+The returned value is valid only within the handler. Do not store references.
 Use [`App.GetString`](./app.md#getstring) or [`App.GetBytes`](./app.md#getbytes) when immutability is enabled, or manually copy values (for example with [`utils.CopyString`](https://github.com/gofiber/utils) / `utils.CopyBytes`) when it's disabled. [Read more...](../#zero-allocation)
 :::
 
@@ -668,7 +667,7 @@ app.Post("/", func(c fiber.Ctx) error {
 
 :::info
 
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 
 :::
@@ -707,7 +706,7 @@ app.Get("/", func(c fiber.Ctx) error {
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::
 
@@ -733,7 +732,7 @@ app.Get("/", func(c fiber.Ctx) error {
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::
 
@@ -756,7 +755,7 @@ app.Get("/", func(c fiber.Ctx) error {
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::
 
@@ -954,7 +953,7 @@ app.Get("/", func(c fiber.Ctx) error {
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::
 
@@ -1005,7 +1004,7 @@ app.Get("/v1/*/shop/*", func(c fiber.Ctx) error {
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::
 
@@ -1182,7 +1181,7 @@ app.Get("/", func(c fiber.Ctx) error {
 ```
 
 :::info
-Returned value is only valid within the handler. Do not store any references.  
+The returned value is valid only within the handler. Do not store references.  
 Make copies or use the [**`Immutable`**](./fiber.md#immutable) setting instead. [Read more...](../#zero-allocation)
 :::