From 9fb0498437f605720c4c66e0855aa0b6e56dbd7c Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Sat, 7 Apr 2018 17:27:53 +0200 Subject: [PATCH] docs(lib): Add a note about getting started with the API docs Adds some initial pointers for newcomers to the documentation that direct them at some of the most commonly used API types. I based these links on what *I* usually end up looking at when I open the actix_web docs. --- src/lib.rs | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index b0d1d76d7..14b6ae266 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -20,13 +20,31 @@ //! } //! ``` //! -//! ## Documentation +//! ## Documentation & community resources +//! +//! Besides the API documentation (which you are currently looking +//! at!), several other resources are available: //! //! * [User Guide](http://actix.github.io/actix-web/guide/) //! * [Chat on gitter](https://gitter.im/actix/actix) //! * [GitHub repository](https://github.com/actix/actix-web) //! * [Cargo package](https://crates.io/crates/actix-web) -//! * Supported Rust version: 1.21 or later +//! +//! To get started navigating the API documentation you may want to +//! consider looking at the following pages: +//! +//! * [App](struct.App.html): This struct represents an actix-web +//! application and is used to configure routes and other common +//! settings. +//! +//! * [HttpServer](server/struct.HttpServer.html): This struct +//! represents an HTTP server instance and is used to instantiate and +//! configure servers. +//! +//! * [HttpRequest](struct.HttpRequest.html) and +//! [HttpResponse](struct.HttpResponse.html): These structs +//! represent HTTP requests and responses and expose various methods +//! for inspecting, creating and otherwise utilising them. //! //! ## Features //! @@ -41,6 +59,7 @@ //! * SSL support with OpenSSL or `native-tls` //! * Middlewares (`Logger`, `Session`, `CORS`, `CSRF`, `DefaultHeaders`) //! * Built on top of [Actix actor framework](https://github.com/actix/actix) +//! * Supported Rust version: 1.21 or later #![cfg_attr(actix_nightly, feature( specialization, // for impl ErrorResponse for std::error::Error