hyper icon indicating copy to clipboard operation
hyper copied to clipboard

Revamp the website guides

Open seanmonstar opened this issue 1 year ago • 5 comments

The guides at https://hyper.rs/guides/1 could use a revamp. They don't explain nearly enough for someone trying to learn. It'd be good for them to be broken up by topic, but also be able to build up to something useful. Here's the outline of guides I've imagined:

  • [x] Init
    • [x] Setup
    • [x] Runtime: Bring Your Own, or hyper_util::rt::Tokio*
  • [ ] Server
    • [x] Hello, world!
    • [ ] Routing?
    • [x] Streaming (Echo)
  • [ ] Client
    • [x] Fetch
    • [x] Post
    • [ ] Connectors, Pools, HTTPS
  • [ ] Bodies
    • [ ] Common
    • [ ] Advanced: Frames
  • [ ] Middleware
    • [x] Service
    • [ ] Tower? Client/Server split?
  • [ ] Proxy: Put it all together
  • [x] Upgrading from 0.14

seanmonstar avatar Nov 15 '23 21:11 seanmonstar

@oddgrd curious what you think of this revamp?

seanmonstar avatar Nov 15 '23 22:11 seanmonstar

I think this is good! The 1.0 guides are definitely a bit sparse, and I think building up to a more complete project is a great way to tie it all together. I am a bit out of the loop, but last I checked the documentation for the new crates was quite sparse as well. As these guides are being written, several of which will use these crates, what is missing in them should also become apparent.

As an aside, I have been wanting to learn more about proxies for a while now, so if I can find the time I would love to contribute to this effort!

And finally, congratulations on the release! :partying_face:

oddgrd avatar Nov 16 '23 20:11 oddgrd

Hi Sean.

I saw the "Connectors, Pools, and HTTPS" section that you added to the Hyper/Client docs within the #1025 issue context. Good addition to the structure of the docs.

I think that the same should be added to the Hyper/Server docs. Overall, we have 2 cases of Hyper usage with TLS.

  1. Hyper server with TLS (HTTPS) support.
  2. Hyper client with TLS (HTTPS) support.

No?

Vagelis-Prokopiou avatar Dec 18 '23 07:12 Vagelis-Prokopiou