Revamp the website guides
Open
Nobody has claimed this yet.
A-docs
E-medium
- Dominant language
- Rust
- Stars
- 16.3k
- Forks
- 1.8k
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 14
Description
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:
- Init
- Setup
- Runtime: Bring Your Own, or
hyper_util::rt::Tokio*
- Server
- Hello, world!
- Routing?
- Streaming (Echo)
- Testing (your Service)
- Client
- Fetch
- Post
- Connectors, Pools, HTTPS
- Bodies
- Common
- Advanced: Frames
- Integrating?
- Service
- Middleware. Tower? Client/Server split?
- Observability (tracing, metrics, etc)
- Proxy: Put it all together
- Upgrading from 0.14
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing guides at https://hyper.rs/guides/1 and comparing them with the issue's proposed outline. Identify the missing or insufficient topics, then reorganize and expand the guides so they build toward useful examples and cover the unchecked Server, Client, Bodies, Integrating, and Proxy sections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100