Roll out comprehensive documentation for ZIO HTTP

[jdegoes]

The documentation can be patterned on http4k, and provide a variety of sections, including:

• 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

The documentation must be built with existing tooling, include examples that are checked for compile-ability with mdoc, and must be copyedited for correct spelling and grammar (possibly with the help of AI tooling).

The overall volume of content would be similar to, but less than, http4k's documentation website.

[jdegoes]

/bounty $2000

[algora-pbc[bot]]

💎 $2,000 bounty • ZIO

Steps to solve:

1. Start working: Comment /attempt #2198 with your implementation plan
2. Submit work: Create a pull request including /claim #2198 in the PR body to claim the bounty
3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to zio/zio-http!

Add a bounty • Share on socials

Attempt	Started (GMT+0)	Solution
🔴 @daveads	May 23, 2023, 10:35:15 AM	WIP
🔴 @feliciien	May 31, 2023, 11:39:13 PM	WIP
🔴 @harshbisle	Jun 4, 2023, 10:26:07 AM	WIP
🔴 @wright-eric	Dec 26, 2023, 5:04:48 AM	WIP
🔴 @varshith257	Apr 17, 2024, 1:05:39 PM	#2838
🔴 @promisingcoder	Jul 18, 2024, 1:23:05 PM	WIP

[harshbisle]

/attempt #2198

[algora-pbc[bot]]

@harshbisle: Please complete your work on zio/zio-cli#184 before attempting another issue.

[harshbisle]

Yes, I will be finishing the zio-cli doc this week and eventually hop on to this issue.

[daveads]

/attempt #2198

[algora-pbc[bot]]

@daveads: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[algora-pbc[bot]]

Note: The user @daveads is already attempting to complete issue #2198 and claim the bounty. If you attempt to complete the same issue, there is a chance that @daveads will complete the issue first, and be awarded the bounty. We recommend discussing with @daveads and potentially collaborating on the same solution versus creating an alternate solution.

[feliciien]

@daveads hello? can we work together?

[harshbisle]

/attempt #2198 Hey @daveads and @feliciien, can I join? What's your progress, BTW?

[feliciien]

i send you friend request

[feliciien]

/attempt #2198

[algora-pbc[bot]]

@feliciien: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[algora-pbc[bot]]

@harshbisle: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[wright-eric]

/attempt #2198

Options

• Cancel my attempt

[varshith257]

/attempt #2198

Options

• Cancel my attempt

[varshith257]

@khajavi @jdegoes Is it ready to work?

[algora-pbc[bot]]

@varshith257: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[varshith257]

@jdegoes Need your guidance here

[algora-pbc[bot]]

The bounty is up for grabs! Everyone is welcome to /attempt #2198 🙌

[varshith257]

@khajavi Let's wait for the response of @daveads for a while and others or I can proceed further to make progress on this if it doesn't get any response on this issue from daveads.

Seems others dropped from long ago with the response of @daveads making progress from a year.

[daveads]

@khajavi Let's wait for the response of @daveads for a while and others or I can proceed further to make progress on this if it doesn't get any response on this issue from daveads.

Seems others dropped from long ago with the response of @daveads making progress from a year.

Decided to break down the PR into smaller pull request so it would be easy for reviewers to review it and then point to them when am finally done... something in that order

[varshith257]

cc: @khajavi I am working alone and will submit PR soon :)

[promisingcoder]

/attempt #2198

Options

• Cancel my attempt

[varshith257]

Hey @promisingcoder, I have done some cool progress on it and waiting for maintainers reviews. It could be duplicate of efforts again if you get started with this. So I think you can have a look at other open issues :)

[algora-pbc[bot]]

@promisingcoder: Reminder that in 7 days the bounty will become up for grabs, so please submit a pull request before then 🙏

[algora-pbc[bot]]

The bounty is up for grabs! Everyone is welcome to /attempt #2198 🙌