Skip to content
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

Add Guides #805

Closed
seanmonstar opened this issue May 24, 2016 · 5 comments

Comments

@seanmonstar
Copy link
Member

commented May 24, 2016

Create a series of guides explaining different topics in hyper, along the lines of https://tokio.rs/docs/getting-started/tokio/

Some topics that seem like good ideas, though organization can be re-worked:

  • Server
    • Hello World
    • Echo
    • File Server/Reverse proxy?
    • Advanced specifics on server's Http, Service, and NewService
  • Client
    • Getting Started
    • Posting a Request Body
    • Configuration/Using TLS
@drusellers

This comment has been minimized.

Copy link

commented Oct 21, 2016

OMG YES

@seanmonstar seanmonstar changed the title Add a Client Guide Add Guides Feb 3, 2017

@pimeys

This comment has been minimized.

Copy link
Contributor

commented Mar 7, 2017

I'd add "Stopping a server cleanly".

@seanmonstar

This comment has been minimized.

Copy link
Member Author

commented Mar 9, 2017

I actually wonder if some of the topics are too small (the routing guide I just wrote feels so tiny). Maybe instead, a list of sufficiently more complicated topics that explore all of the required topics, such as:

  1. hello world
  2. echo
  3. file serving

They would definitely cover all the original topics, but it may not be obvious from their titles?

@hjr3

This comment has been minimized.

Copy link

commented Mar 10, 2017

I think showing the examples is a good place to start. One of the more challenging things about understanding futures, tokio and hyper is context. Examples, such a hello world, show more of that context and give people a better chance of solving their problem.

I do think there is value in doing a deep-dives on a particular topic, but I think examples and spelunking through source is good enough until things really stabilize.

@seanmonstar

This comment has been minimized.

Copy link
Member Author

commented Jun 13, 2017

The docs that will exist for the v0.11 release are done. Clearly, there is always room for more, and better, docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.