From b5a40256ddd5585d12c2a01771eb93d4a8630a62 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Tue, 24 May 2016 14:50:27 +0200
Subject: Partial update of the user guide

I will do more breaking changes before documenting more.
---
 doc/src/guide/book.asciidoc | 30 ++++++++++++++++++++++--------
 1 file changed, 22 insertions(+), 8 deletions(-)

(limited to 'doc/src/guide/book.asciidoc')

diff --git a/doc/src/guide/book.asciidoc b/doc/src/guide/book.asciidoc
index 15aa42b..b1c54d8 100644
--- a/doc/src/guide/book.asciidoc
+++ b/doc/src/guide/book.asciidoc
@@ -3,6 +3,11 @@
 
 = Cowboy User Guide
 
+// REST: where should i handle bindings? init, probably. qs? in media type functions
+// REST: explain how a module per media type is good; module may be shared between client/server
+
+// @todo Put the list of RFCs and other documents supported somewhere.
+
 = Rationale
 
 include::modern_web.asciidoc[The modern Web]
@@ -15,25 +20,31 @@ include::introduction.asciidoc[Introduction]
 
 include::getting_started.asciidoc[Getting started]
 
-include::overview.asciidoc[Request overview]
-
-include::erlang_beginners.asciidoc[Erlang for beginners]
+// NEW! Flow diagram here
+// MERGE include::overview.asciidoc[Request overview]
+include::flow_diagram.asciidoc[Flow diagram]
 
 = Configuration
 
-include::routing.asciidoc[routing]
+include::listeners.asciidoc[Listeners]
 
-include::constraints.asciidoc[Constraints]
+include::streams.asciidoc[Streams]
 
-include::static_files.asciidoc[Static files]
+include::routing.asciidoc[Routing]
 
-= Request and response
+include::constraints.asciidoc[Constraints]
+
+= Handlers
 
 include::handlers.asciidoc[Handlers]
 
 include::loop_handlers.asciidoc[Loop handlers]
 
-include::req.asciidoc[The Req object]
+include::static_files.asciidoc[Static files]
+
+= Request and response
+
+include::req.asciidoc[Request details]
 
 include::req_body.asciidoc[Reading the request body]
 
@@ -61,12 +72,15 @@ include::ws_handlers.asciidoc[Handling Websocket connections]
 
 = Internals
 
+// TODO: shouldn't be needed anymore?
 include::architecture.asciidoc[Architecture]
 
+// TODO: Move into Common scenarios or something; switch to streams
 include::broken_clients.asciidoc[Dealing with broken clients]
 
 include::middlewares.asciidoc[Middlewares]
 
 include::sub_protocols.asciidoc[Sub protocols]
 
+// TODO: they're gone
 include::hooks.asciidoc[Hooks]
-- 
cgit v1.2.3

