Missing Section: Required Knowledge

tokio-rs / doc-push

Tokio doc blitz effort - A concerted effort to improve Tokio's documentation.

MIT License

50 stars 7 forks source link

Missing Section: Required Knowledge #13

Open rylev opened 5 years ago

rylev commented 5 years ago

There are people who will read the guide who don't have a super solid grasp on fundamentals. Beyond basic knowledge of Rust programming the getting started guides already assume the following:

TCP Sockets
Threads and thread pools
Some advanced Rust topics e.g. impl Trait, lifetime bounds, VecDeque, etc.

Making sure the reader is either introduced to these topics or is told where to find out more about them before continuing the Tokio guides is important.

carllerche commented 5 years ago

Where in the outline should this go?

It seems like it should be early, but I also am unsure about having too much stuff before you get into the tutorial.

rylev commented 5 years ago

I think this is very much related to #10. If we can figure out how to properly introduce Tokio to less advanced readers without getting in the way of advanced readers, we'll solve both issues.

I'm wondering if we should actually collapse these two issues into one issue: "Ensure Docs are Both Beginner and Advanced Friendly"

carllerche commented 5 years ago

You may now make outline change suggestions via PR 👍