zio-http icon indicating copy to clipboard operation
zio-http copied to clipboard

Docs rewrite

Open daveads opened this issue 1 year ago • 6 comments

Roll out Comprehensive documentation for ZIO HTTP #2198

Would like to keep experimenting and exploring zio-http to better understand what's going on and constantly update the doc...

  • Introduction ✅
  • Concepts
    • 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 ✅

/claim #2198

daveads avatar Dec 26 '23 10:12 daveads

Codecov Report

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

Project coverage is 64.56%. Comparing base (137d4f0) to head (54bf27d).

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

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2570   +/-   ##
=======================================
  Coverage   64.56%   64.56%           
=======================================
  Files         148      148           
  Lines        8649     8649           
  Branches     1573     1573           
=======================================
  Hits         5584     5584           
  Misses       3065     3065           

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

codecov-commenter avatar Dec 26 '23 10:12 codecov-commenter

To avoid conflict, I'm informing you that I'm going to work on this PR to make it ready for merge. Please let me know if you have any notes. @daveads

khajavi avatar Jan 29 '24 11:01 khajavi

@daveads I have fixed the CI and now it is showing green. I noticed that you wrote some good code, but it seems like you haven't worked on it in a month. Can you please let me know what your plan is? Do you intend to continue working on it or would you like me to assist you in completing the PR and splitting the bouncy?

khajavi avatar Jan 30 '24 11:01 khajavi

Hello @daveads I added a couple of other comments to your work. So I believe this is still far from being completed. Also before asking for another review, please make sure all the examples are compile-safe, using mdoc modifier. Anyway, please let me know if you're going to continue working on this. I'm here to help if you want.

khajavi avatar Feb 11 '24 17:02 khajavi

In relation to @khajavi I converted this to a draft

987Nabil avatar Feb 12 '24 20:02 987Nabil

In relation to @khajavi I converted this to a draft

Alright

daveads avatar Feb 16 '24 07:02 daveads

@daveads Please re-open if you get a chance to complete!

jdegoes avatar Apr 16 '24 21:04 jdegoes