-
Notifications
You must be signed in to change notification settings - Fork 374
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added Comprehensive documentation for ZIO HTTP #2838
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: M-Vamshi <21211a05f1@bvrit.ac.in>
Signed-off-by: M-Vamshi <21211a05f1@bvrit.ac.in>
Hello @varshith257 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. |
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 :) |
@varshith257 |
Can you review and provide suggestions where to improve and needed changes? |
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. |
@khajavi Modified concepts with your suggestions and thanks for the review. PTAL Meanwhile I will start working on adding How to guides |
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #2838 +/- ##
==========================================
- Coverage 64.64% 64.61% -0.04%
==========================================
Files 156 156
Lines 9113 9122 +9
Branches 1584 1596 +12
==========================================
+ Hits 5891 5894 +3
- Misses 3222 3228 +6 ☔ View full report in Codecov by Sentry. |
I think concepts and tutorial sections are ready for your final review. Please take a look |
@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. |
@jdegoes Have look at it and review the changes |
Fixes Roll out comprehensive documentation for ZIO HTTP #2198
/claim Roll out comprehensive documentation for ZIO HTTP #2198
Introduction
Concept
Routing
Request Handling
Server
Client
Middleware
Endpoint
Tutorials
Your First ZIO HTTP App
Deploying a ZIO HTTP App
Testing Your ZIO HTTP App
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