docusaurus preparations for the recipes

[ReneWerner87]

Summary by CodeRabbit

• New Features

  • Introduced various new README files for different example projects using the Fiber framework, covering topics such as authentication, database integration, file uploads, and more.
  • Added documentation for implementing custom features like 404 handlers, JWT authentication, and internationalization.

• Documentation

  • Comprehensive guides for setting up and running multiple example applications, including prerequisites, setup instructions, and code overviews.
  • Enhanced project structure and usage sections for better user understanding and navigation.

• Bug Fixes

  • Improved clarity and structure in existing documentation to enhance user experience and reduce confusion.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several new README files across various directories, documenting examples and implementations using the Go Fiber framework. Key changes include the addition of detailed guides for setting up applications with features such as authentication, database integration, file uploads, and WebSocket communication. Additionally, the structure and naming conventions in existing files have been updated, particularly in the default_sidebars.js, which reflects a more organized sidebar configuration.

Changes

File Path	Change Summary
default_sidebars.js	Renamed variable sidebars to default_sidebars and tutorialSidebar to left_sidebar.
docs/recipes/404-handler/README.md	New file created for a custom 404 handler using Fiber.
docs/recipes/README.md	New file added for the Fiber cookbook with an overview and table of contents.
docs/recipes/air/README.md	New file created for live reloading setup using Air.
docs/recipes/auth-docker-postgres-jwt/README.md	New file added for authentication example with Docker, Postgres, and JWT.
docs/recipes/auth-jwt/README.md	New file created for JWT authentication example.
docs/recipes/autocert/README.md	New file added for setting up HTTPS with Let's Encrypt.
docs/recipes/aws-eb/README.md	New file created for deploying a Go Fiber application to AWS Elastic Beanstalk.
docs/recipes/aws-sam-container/README.md	New file added for deploying a serverless application using AWS SAM and Docker.
docs/recipes/aws-sam/README.md	New file created for AWS SAM recipes and deployment instructions.
docs/recipes/bootstrap/README.md	New file added for Bootstrap recipe using Fiber with Gorm and Validator.
docs/recipes/clean-architecture/README.md	New file created for Clean Architecture example using Fiber and MongoDB.
docs/recipes/cloud-run/README.md	New file added for deploying a Go Fiber application to Google Cloud Run.
docs/recipes/colly-gorm/README.md	New file created for a web scraping application using Fiber and Gorm.
docs/recipes/csrf-with-session/README.md	New file added for implementing CSRF protection with session management.
docs/recipes/csrf/README.md	New file created for CSRF example project.
docs/recipes/docker-mariadb-clean-arch/README.md	New file added for a Dockerized REST application using Clean Architecture with MariaDB.
docs/recipes/docker-nginx-loadbalancer/README.md	New file created for Docker and Nginx setup with load balancing.
docs/recipes/dummyjson/README.md	New file added for a proxy server example using the Fiber framework.
docs/recipes/ent-mysql/README.md	New file created for Entgo ORM with MySQL example.
docs/recipes/entgo-sveltekit/README.md	New file added for a full-stack Todo application using Sveltekit and Fiber.
docs/recipes/geoip-maxmind/README.md	New file created for GeoIP functionality using MaxMind databases.
docs/recipes/geoip/README.md	New file added for setting up a GeoIP lookup service using Fiber.
docs/recipes/gorm-mysql/README.md	New file created for GORM MySQL example.
docs/recipes/gorm-postgres/README.md	New file added for GORM PostgreSQL example.
docs/recipes/gorm/README.md	New file created for GORM example with SQLite.
docs/recipes/graceful-shutdown/README.md	New file added for graceful shutdown implementation using Fiber.
docs/recipes/graphql/README.md	New file created for setting up a GraphQL server using Fiber.
docs/recipes/grpc/README.md	New file added for gRPC example using Fiber.
docs/recipes/hello-world/README.md	New file created for a "Hello, World!" example application using Fiber.
docs/recipes/heroku/README.md	New file added for deploying a Go application on Heroku using Fiber.
docs/recipes/hexagonal/README.md	New file created for a hexagonal architecture example using Fiber and MongoDB.
docs/recipes/https-pkcs12-tls/README.md	New file added for setting up HTTPS with PKCS12 TLS.
docs/recipes/https-tls/README.md	New file created for setting up an HTTPS server with TLS using Fiber.
docs/recipes/i18n/README.md	New file added for implementing internationalization in Fiber applications.
docs/recipes/jwt/README.md	New file created for JWT authentication example using Fiber.
docs/recipes/k8s/README.md	New file added for deploying a Go application on Kubernetes.
docs/recipes/memgraph/README.md	New file created for setting up a Fiber backend with Memgraph.
docs/recipes/minio/README.md	New file added for MinIO file upload and download example.
docs/recipes/mongodb/README.md	New file created for MongoDB example project using Fiber.
docs/recipes/multiple-ports/README.md	New file added for running a Go application on multiple ports.
docs/recipes/mysql/README.md	New file created for MySQL example project using Fiber.
docs/recipes/neo4j/README.md	New file added for Neo4j example project within Fiber.
docs/recipes/oauth2-google/README.md	New file created for implementing Google OAuth2 authentication in Fiber.
docs/recipes/oauth2/README.md	New file added for OAuth2 authentication implementation in Go applications.
docs/recipes/optional-parameter/README.md	New file created for handling optional parameters in Fiber applications.
docs/recipes/parsley/README.md	New file added for integrating Parsley dependency injection with Fiber.
docs/recipes/postgresql/README.md	New file created for PostgreSQL example project using Fiber.
docs/recipes/prefork/README.md	New file added for using the Prefork feature in Fiber applications.
docs/recipes/rabbitmq/README.md	New file created for RabbitMQ integration with Fiber.
docs/recipes/react-router/README.md	New file added for React Router integration with Fiber.
docs/recipes/recover/README.md	New file created for implementing recovery middleware in Fiber.
docs/recipes/rss-feed/README.md	New file added for creating an RSS feed with Fiber.
docs/recipes/server-timing/README.md	New file created for implementing Server-Timing headers in Fiber.
docs/recipes/sessions-sqlite3/README.md	New file added for managing sessions with SQLite3 in Fiber.
docs/recipes/socketio/README.md	New file created for a Socket.io WebSocket chat example with Fiber.
docs/recipes/spa/README.md	New file added for setting up a Single Page Application with React and Fiber.
docs/recipes/sqlboiler/README.md	New file created for integrating Sqlboiler ORM with Fiber.
docs/recipes/sqlc/README.md	New file added for integrating sqlc with Fiber.
docs/recipes/sse/README.md	New file created for implementing Server-Sent Events with Fiber.
docs/recipes/stream-request-body/README.md	New file added for handling streaming request bodies in Fiber.
docs/recipes/svelte-netlify/README.md	New file created for deploying a Fiber application on Netlify.
docs/recipes/sveltekit-embed/README.md	New file added for a full-stack application using SvelteKit and Fiber.
docs/recipes/swagger/README.md	New file created for integrating Swagger API documentation in Fiber applications.
docs/recipes/tableflip/README.md	New file added for using the Tableflip library for graceful upgrades in Go applications.
docs/recipes/template-asset-bundling/README.md	New file created for asset bundling using Fiber, Tailwind CSS, and Parcel.
docs/recipes/template/README.md	New file added for a template project with Fiber and asset bundling.
docs/recipes/todo-app-with-auth-gorm/README.md	New file created for a Todo application with authentication using GORM.
docs/recipes/unit-test/README.md	New file added for unit testing in a Go Fiber application.
docs/recipes/upload-file/README.md	New file created for handling file uploads in Fiber applications.
docs/recipes/url-shortener-api/README.md	New file added for a URL Shortener API project.
docs/recipes/validation/README.md	New file created for implementing input validation in Fiber applications.
docs/recipes/vercel/README.md	New file added for deploying a Go Fiber application on Vercel.
docs/recipes/websocket-chat/README.md	New file created for a WebSocket chat application example using Fiber.

Poem

In the land of code where rabbits play,
New README files hop in every way.
From 404s to JWTs, they guide with cheer,
With Fiber and Go, the path is clear!
So let’s code and create, with joy in our hearts,
For every new change, a fresh start imparts! 🐇✨

Warning

Rate limit exceeded

@ReneWerner87 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 53 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8c6a7b2 and 1a8705c.

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[ReneWerner87]

• automatically(plugin|preprocessing?) add a link to github and stackblitz in every example
  https://stackblitz.com/github/gofiber/recipes/tree/master/404-handler<- example dir

@coderabbitai add a summary for the PR

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@ReneWerner87, here's the summary for the PR:

This pull request prepares the documentation for integrating recipes using Docusaurus. It includes steps to automatically add links to GitHub and StackBlitz in every example, possibly using a plugin or preprocessing. This enhancement will make code examples easily accessible and interactive for users.

---

✏️ Learnings added

Learnt from: ReneWerner87
URL: https://github.com/gofiber/docs/pull/435

Timestamp: 2024-11-26T13:51:30.700Z
Learning: Ensure that every example in the documentation automatically includes links to GitHub and StackBlitz, possibly through a plugin or preprocessing step.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@ReneWerner87, here's an updated summary for the PR:

This pull request enhances the GoFiber documentation by preparing it for integrating recipes using Docusaurus. It focuses on automatically adding links to GitHub and StackBlitz in every example, possibly through a plugin or preprocessing step. An example directory is provided at StackBlitz, demonstrating how code examples can be interactive and easily accessible. This improvement aims to make the documentation more user-friendly by allowing readers to directly interact with code samples.

(_/)
(•_•)
/ ♥️ I hope this summary meets your expectations!

---

🧠 Learnings used

Learnt from: ReneWerner87
PR: gofiber/docs#0
File: :0-0
Timestamp: 2024-11-26T13:51:30.843Z
Learning: Ensure that every example in the documentation automatically includes links to GitHub and StackBlitz, possibly through a plugin or preprocessing step.

[ReneWerner87]

• fix build
  
  https://github.com/gofiber/docs/actions/runs/12032017303/job/33542852971

[ReneWerner87]

locally

[ReneWerner87]

gofiber/recipes#2703 is related

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@ReneWerner87, here's an updated summary for the PR:

This pull request enhances the GoFiber documentation by preparing it for integrating recipes using Docusaurus. The key objectives include:

• Automatically adding links to GitHub and StackBlitz in every example, possibly through a plugin or preprocessing step. An example directory is provided at StackBlitz, demonstrating interactive code examples.

• Fixing build issues to ensure the documentation compiles correctly. Build failures were observed both locally and in the CI pipeline (GitHub Actions log), and have been addressed.

• Related PR: This work is connected to gofiber/recipes#2703, which provides additional context and improvements related to the documentation and recipe integrations.

These enhancements aim to make the documentation more user-friendly by allowing readers to directly interact with code samples and ensuring the documentation builds successfully.

(_/)
(•_•)
/ ♥️ I hope this summary meets your expectations!