Added Comprehensive documentation for ZIO HTTP

[varshith257]

• Fixes #2198 /claim #2198

• Introduction

• Concept

• [x] Routing

• [x] Request Handling

• [x] Server

• [x] Client

• [x] Middleware

• [x] Endpoint

• Tutorials

• [x] Your First ZIO HTTP App

• [x] Deploying a ZIO HTTP App

• [x] Testing Your ZIO HTTP App

• [x] How-to-guides (This should be based off the list of topics at http4k, but should also include ZIO HTTP use cases around Endpoint, middleware, etc.)

• Reference

• [ ] API Docs

• [ ] Server backend

• [ ] Websockets

• [ ] JSON Handling

• [ ] Metrics

• [ ] Request Logging (etc.)

• [ ] Performance

• [ ] FAQ

[!NOTE]
sidebar.js will be updated soon with added new files

[varshith257]

@khajavi @987Nabil PTAL. I am ready to commit my time for the next 4-5 days to work on this issue completely.

I am adding commits one by one completely to ease the review section-wise. Your review and suggestions could be valuable for adding comprehensive documentation to our zio-http docs website

[varshith257]

@jdegoes @khajavi @guizmaii @987Nabil Can you review this at your free time?

[khajavi]

Hello @varshith257 Thanks for your contribution! I took a look at your work! I think we need to clarify some terms. So before moving forward, let's see how I think about different sections of the documentation project (in this case ZIO HTTP).

Index - This section serves as a brief introduction to the project, showcasing its capabilities through only one or two simplest examples.

Concept - The Concept section delves into the foundational principles, terminologies, ideas, and methodologies. It should provide users with an understanding of the core domain or the fundamental concepts related to the problem being addressed. We don't need to provide working examples there! It should also give users an overview of the solution in general terms, helping them grasp the key ideas before delving into more detailed information.

Overview - As the initial practical encounter for users after familiarizing themselves with the concepts, the overview section provides compilable code snippets. These snippets demonstrate the implementation of concepts in real-world scenarios, offering users insight into how to utilize ZIO‌ HTTP effectively. Additionally, this section may include showcases to exemplify the range of functionalities achievable with the library.

Reference - This section delves deeper into the API reference, offering comprehensive documentation for users seeking detailed information on specific functionalities and methods within the library.

[varshith257]

Sure! Same this are in my mind too. I am bit confused about client configuration. First I have updated with basic code like a basic pseudo code of it for better understanding but checks are constantly failing. So I changed again to the examples its compiling.

I have done with almost every sections mentioned in the issue but waiting first get reviewed concepts and tutorial sections and make ease for review as well as to craft a comprehensive documentation for them and then let's go with other.

I want to complete this long awaiting issue before May 17 exactly a year back the issue created 😅

Looking forward for your review and suggestions :)

[khajavi]

@varshith257 I think we are not on the same page, as I see kinds of stuff that are mostly practical stuffs instead of core concepts. We only need to cover terms and concepts, at best with "no" examples to demonstrate general concepts for each page in this section (or at most with one example for each page). What you have done until now is somehow similar to a practical overview.

[varshith257]

We only need to cover terms and concepts, at best with "no" examples to demonstrate general concepts for each page in this section (or at most with one example for each page).

Okay will remove the examples and explain concepts with no examples. If needed I will least provide pseudocode for demonstration of concept.

I think we can provide one example in the last of each concept discussed in the page.

[varshith257]

@varshith257 I think we are not on the same page, as I see kinds of stuff that are mostly practical stuffs instead of core concepts. We only need to cover terms and concepts, at best with "no" examples to demonstrate general concepts for each page in this section (or at most with one example for each page). What you have done until now is somehow similar to a practical overview.

@khajavi Modified concepts with your suggestions and thanks for the review. PTAL

Meanwhile I will start working on adding How to guides

[codecov-commenter]

:warning: Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 65.87%. Comparing base (e9f1c02) to head (e7f84bf). Report is 29 commits behind head on main.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2838      +/-   ##
==========================================
+ Coverage   64.78%   65.87%   +1.08%     
==========================================
  Files         157      156       -1     
  Lines        9395     9688     +293     
  Branches     1743     1802      +59     
==========================================
+ Hits         6087     6382     +295     
+ Misses       3308     3306       -2     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

[varshith257]

I think concepts and tutorial sections are ready for your final review. Please take a look

[varshith257]

@jdegoes @khajavi I have also added the list of topics of how-to-guides based on http4k docs as mentioned in the issue. Waiting for the reviews

[varshith257]

@jdegoes Any luck on this for getting reviewed? I am ready to push other sections too which are in my local machine once this sections are get reviewed.

[varshith257]

@khajavi @vigoo Can you have a initial review on this? I will fix merge conflicts in mean time and fix errors araised in build :)

[varshith257]

@jdegoes @987Nabil Could you take a look on it?

[varshith257]

@jdegoes Any particular reason for closing this PR?

I have followed with @khajavi and @987Nabil for it and got response of will be followed for this PR review at end of August