[v3 Maintenance]: Consolidate and Document Core Changes in v3

[ReneWerner87]

Maintenance Task Description

The task is to identify and document all core changes that have been made in the beta branch for the upcoming v3 release. This includes updating the documentation to reflect these changes, providing examples for new usage patterns, and creating a migration guide if necessary.

Tasks

• Review commit history and pull requests in the beta branch to identify all core changes since the last sync with v2.
• Write a "What's New" markdown document in the root folder, summarizing the significant core changes. (for the release)
• Update the documentation with the new v3 API changes and usage patterns.
• Provide code examples that demonstrate the new features or changes in usage.
• Create a migration guide in the docs folder for transitioning from v2 to v3, if required.

Expected Outcome

• A "What's New" markdown document for core changes that can be used for release notes.
• Updated v3 documentation with clear examples and migration guide for current users.

Summary by CodeRabbit

• New Features

  • Introduced a new method for content negotiation based on the Accept HTTP header.
  • Added utility functions leveraging generics for type-safe operations.
  • New documentation on request and response binding, and redirect functionalities.

• Enhancements

  • Updated API documentation with restructured sections and new method descriptions.
  • Improved clarity in existing comments and method descriptions throughout the codebase.
  • Enhanced error handling descriptions and method signatures in documentation.

• Bug Fixes

  • Corrected markdown syntax error in CSRF middleware documentation.
  • Fixed incorrect hyperlink in cache middleware documentation.

• Refactor

  • Renamed and simplified various methods and interfaces for consistency and extensibility.
  • Updated test function names to align with actual functionality being tested.

• Documentation

  • Added comprehensive guides and updated existing documentation to reflect new features and changes.
  • Introduced a new 'What's New' document detailing the features and changes in the latest major release.

[coderabbitai]

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

Commits

Files that changed from the base of the PR and between 4d1e993 and 400e8c1.

Files selected for processing (34)

• app.go (4 hunks)
• bind.go (6 hunks)
• bind_test.go (1 hunks)
• constants.go (1 hunks)
• ctx.go (5 hunks)
• ctx_interface.go (5 hunks)
• ctx_test.go (10 hunks)
• docs/api/category.json (1 hunks)
• docs/api/app.md (17 hunks)
• docs/api/bind.md (1 hunks)
• docs/api/client.md (2 hunks)
• docs/api/constants.md (5 hunks)
• docs/api/ctx.md (29 hunks)
• docs/api/fiber.md (5 hunks)
• docs/api/hooks.md (1 hunks)
• docs/api/log.md (1 hunks)
• docs/api/redirect.md (1 hunks)
• docs/extra/category.json (1 hunks)
• docs/extra/faq.md (1 hunks)
• docs/guide/category.json (1 hunks)
• docs/guide/error-handling.md (1 hunks)
• docs/guide/faster-fiber.md (1 hunks)
• docs/guide/routing.md (5 hunks)
• docs/guide/utils.md (1 hunks)
• docs/guide/validation.md (1 hunks)
• docs/intro.md (1 hunks)
• docs/middleware/category.json (1 hunks)
• docs/middleware/cache.md (1 hunks)
• docs/middleware/csrf.md (2 hunks)
• docs/partials/routing/handler.md (3 hunks)
• docs/whats_new.md (1 hunks)
• helpers.go (2 hunks)
• listen.go (1 hunks)
• redirect.go (11 hunks)

 __________________
< Zero bugs given. >
 ------------------
  \
   \   \
        \ /\
        ( )
      .( o ).

---

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.

[codecov]

Codecov Report

Attention: Patch coverage is 79.48718% with 16 lines in your changes are missing coverage. Please review.

❗ No coverage uploaded for pull request base (main@4d1e993). Click here to learn what that means.

Files	Patch %	Lines
helpers.go	78.26%	13 Missing and 2 partials ⚠️
bind.go	87.50%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2934   +/-   ##
=======================================
  Coverage        ?   82.85%           
=======================================
  Files           ?      115           
  Lines           ?     8409           
  Branches        ?        0           
=======================================
  Hits            ?     6967           
  Misses          ?     1105           
  Partials        ?      337           

Flag	Coverage Δ
unittests	82.85% <79.48%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ReneWerner87]

i will work on the "Whats new" markdown in a new PR

[coderabbitai]

Actionable comments posted: 10