umgeher/cowboy
0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 20:50:24 +00:00
Code Issues Wiki Activity

Partial update of the user guide

Browse source 
I will do more breaking changes before documenting more.
This commit is contained in:
Loïc Hoguin 2016-05-24 14:50:27 +02:00
parent 25912dfc05
commit b5a40256dd
9 changed files with 199 additions and 273 deletions
Download patch file Download diff file Expand all files Collapse all files

30
doc/src/guide/book.asciidoc
View file

@ -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::streams.asciidoc[Streams]
include::routing.asciidoc[Routing]
include::constraints.asciidoc[Constraints]
include::static_files.asciidoc[Static files]
= Request and response
= 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]