aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide/book.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-05-24 14:50:27 +0200
committerLoïc Hoguin <[email protected]>2016-05-24 14:50:27 +0200
commitb5a40256ddd5585d12c2a01771eb93d4a8630a62 (patch)
tree9d03e630d501852b216a8b7990a1d03a02e9f4dd /doc/src/guide/book.asciidoc
parent25912dfc05e45e0f4453f689410fce80a1af69ab (diff)
downloadcowboy-b5a40256ddd5585d12c2a01771eb93d4a8630a62.tar.gz
cowboy-b5a40256ddd5585d12c2a01771eb93d4a8630a62.tar.bz2
cowboy-b5a40256ddd5585d12c2a01771eb93d4a8630a62.zip
Partial update of the user guide
I will do more breaking changes before documenting more.
Diffstat (limited to 'doc/src/guide/book.asciidoc')
-rw-r--r--doc/src/guide/book.asciidoc30
1 files changed, 22 insertions, 8 deletions
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]