Docs: Add comprehensive ZIO HTTP documentation to address #2198

[zelosleone]

This pull request introduces a comprehensive set of documentation for ZIO HTTP, aiming to address the lack of clear and structured documentation as outlined in issue #2198 Well, hopefully.

Key Changes:

• New Documentation Structure: The documentation is structured to cover key areas of ZIO HTTP, including:

  • Introduction
  • Getting Started
  • Server
  • Client
  • Advanced Features
  • Integration & Ecosystem
  • Testing & Observability
  • Deployment & Production
  • Best Practices
  • Real-World Examples
  • Migration & Reference
  • FAQ

• Detailed Explanations: Each section provides detailed explanations of ZIO HTTP concepts, features, and best practices etc.

• Code Examples: The documentation includes numerous code examples that are designed to be compile-able using mdoc. These examples cover various use cases, including:

  • Basic server and client setup
  • Routing and request handling
  • Middleware implementation
  • WebSocket usage
  • Streaming
  • Metrics integration
  • Template system
  • Compression and rate limiting
  • OpenAPI generation
  • Integration with other ZIO libraries

• Real-World Examples: The "Real-World Examples" section provides practical examples of how to use ZIO HTTP in real-world scenarios, such as:

  • REST API with CRUD operations
  • Authentication flow
  • File upload with progress
  • WebSocket chat application
  • Server-Sent Events (SSE)
  • Rate-limited API with custom metrics
  • Error recovery patterns

• Migration Guide: The "Migration & Reference" section includes a migration guide for users upgrading from older versions of ZIO HTTP.

• FAQ: The "FAQ" section addresses common questions about ZIO HTTP.

• mdoc Integration: Made sure to check it via mdoc, but I am happy to receive further feedback on this.

For Further Adjustments:

• Please review the documentation and provide feedback.
• If you have any questions or suggestions, please let me know.

[CLAassistant]

All committers have signed the CLA.

[987Nabil]

We have already structure and docs. Has nothing to do with the ticket.