The only thing I'm always struggling to understand is the documentation on docs.rs

• docs.rs

  66 835 8.1 Rust

  crates.io documentation generator

  

  Now, some projects include tutorial-style documentation, but you wouldn't find it on docs.rs, it would be in some other place. Maybe in a Git repo there would be examples, or some projects have books and even large sites (like tokio.rs)… but that's not reference documentation.

• mdBook

  50 12,311 8.2 Rust

  Create book from markdown files. Like Gitbook but implemented in Rust

  

  Separately, though: docs.rs is an interface to "rustdoc" output and rustdoc is primarily aimed at reference-type documentation, rather than guide-type documentation. It's possible but more challenging to present broad introductory content in that format, which I imagine is why the Rust community also likes to use mdBook to publish book-like content which is complementary to the rustdoc-based reference documentation. Unfortunately there isn't a standard place for accessing "books" for crates or families of crates, so they can be harder to discover than the rustdoc output on docs.rs. I tend to find these "books" via a link in the project's readme, rather than from the rustdoc.

• InfluxDB

  www.influxdata.com

  sponsored

  Build time-series-based applications quickly and at scale.. InfluxDB is the Time Series Platform where developers build real-time applications for analytics, IoT and cloud-native services. Easy to start, it is available in the cloud or on-premises.

  

• tokio

  64 19,098 9.2 Rust

  A runtime for writing reliable asynchronous applications with Rust. Provides I/O, networking, scheduling, timers, ...

  

  Now, some projects include tutorial-style documentation, but you wouldn't find it on docs.rs, it would be in some other place. Maybe in a Git repo there would be examples, or some projects have books and even large sites (like tokio.rs)… but that's not reference documentation.

• axum

  73 8,379 9.2 Rust

  Ergonomic and modular web framework built with Tokio, Tower, and Hyper

  

  But on github you may find some examples. And often even if examples are included like in axum case you may find a lot more on a github.

Suggest a related project