🧹 Maintenance: Fix merge conflict in documentation

[gaby]

Description

Fix merge conflict in EarlyData middleware documentation

Fixes #2956

Changes introduced

• Documentation Update: Detail the updates made to the documentation and links to the changed files.

Type of change

Please delete options that are not relevant.

• Documentation update (changes to documentation)

[coderabbitai]

Walkthrough

The recent updates to the earlydata middleware involve enhancements to the Config struct, including a new method for identifying early data via custom headers and refining request safety based on HTTP methods. Additionally, the update introduces better error handling for rejected early-data requests, ensuring a more robust middleware operation.

Changes

File	Change Summary
docs/api/middleware/earlydata.md	Updated Config struct functionality in earlydata middleware documentation.

Assessment against linked issues

Objective	Addressed	Explanation
🧹 [Maintenance]: Fix pushed merge-conflict in /docs/api/middleware/earlydata.md (#2956)	✅

🐰✨
In the land of code where the snippets roam free,
A rabbit hopped in, as happy as can be.
With a flick and a fix in the middleware's heart,
Merge conflicts and errors, it tore apart.
"Hop, skip, a leap!" it cheerfully said,
"With clearer docs, ahead we tread!"
🌟📚🐾

---

Recent Review Status

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 8fc8ad9 and 76470c2.

Files selected for processing (1)

• docs/api/middleware/earlydata.md (2 hunks)

Additional comments not posted (4)

docs/api/middleware/earlydata.md (4)

Line range hint 10-10: Consider rephrasing to avoid wordiness.

Instead of "in order to not trust bogus HTTP request headers," consider "to avoid trusting bogus HTTP request headers."

---

Line range hint 12-12: Possible spelling mistake detected.

Consider verifying the spelling of "replayable" to ensure accuracy.

---

Line range hint 17-17: Possible spelling mistake detected.

Consider verifying the spelling in this section for accuracy.

---

50-55: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [53-58]

Remove extra whitespaces and add missing spaces between sentences.

- | Property       | Type                    | Description                                                                          | Default                                                |
+ | Property       | Type                   | Description                                                                         | Default                                               |
- | Next           | `func(fiber.Ctx) bool` | Next defines a function to skip this middleware when returned true.                  | `nil`                                                  |
+ | Next           | `func(fiber.Ctx) bool` | Next defines a function to skip this middleware when returned true.                 | `nil`                                                 |
- | IsEarlyData    | `func(fiber.Ctx) bool` | IsEarlyData returns whether the request is an early-data request.                    | Function checking if "Early-Data" header equals "1"    |
+ | IsEarlyData    | `func(fiber.Ctx) bool` | IsEarlyData returns whether the request is an early-data request.                   | Function checking if "Early-Data" header equals "1"   |
- | AllowEarlyData | `func(fiber.Ctx) bool` | AllowEarlyData returns whether the early-data request should be allowed or rejected. | Function rejecting on unsafe and allowing safe methods |
+ | AllowEarlyData | `func(fiber.Ctx) bool` | AllowEarlyData returns whether the early-data request should be allowed or rejected.| Function rejecting on unsafe and allowing safe methods|
- | Error          | `error`                 | Error is returned in case an early-data request is rejected.                         | `fiber.ErrTooEarly`                                    |
+ | Error          | `error`                | Error is returned in case an early-data request is rejected.                        | `fiber.ErrTooEarly`                                   |

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Actionable comments outside the diff hunks (1)

docs/api/middleware/earlydata.md (1)

Line range hint 5-5: Consider correcting the spelling mistake.

- --- id: earlydata ---
+ --- id: early-data ---