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

Various fixes and tweaks to the user guide

This commit is contained in:
Loïc Hoguin 2017-01-02 14:20:15 +01:00
parent 5838a0c81a
commit 271e31c629
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
8 changed files with 66 additions and 29 deletions

View file

@ -21,16 +21,12 @@ include::introduction.asciidoc[Introduction]
include::getting_started.asciidoc[Getting started]
// NEW! Flow diagram here
// MERGE include::overview.asciidoc[Request overview]
include::flow_diagram.asciidoc[Flow diagram]
= Configuration
include::listeners.asciidoc[Listeners]
include::streams.asciidoc[Streams]
include::routing.asciidoc[Routing]
include::constraints.asciidoc[Constraints]
@ -69,19 +65,35 @@ include::resource_design.asciidoc[Designing a resource handler]
include::ws_protocol.asciidoc[The Websocket protocol]
include::ws_handlers.asciidoc[Handling Websocket connections]
include::ws_handlers.asciidoc[Websocket handlers]
= Internals
= Advanced
// 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::streams.asciidoc[Streams]
include::middlewares.asciidoc[Middlewares]
// @todo Rather have two chapters, custom handlers and custom protocol upgrades
include::sub_protocols.asciidoc[Sub protocols]
// TODO: they're gone
//= Additional information
//include::migrating_from_1.0.asciidoc[Migrating from Cowboy 1.0 to 2.0]
// @todo Maybe history? Could take info from architecture also.
= Deprecated chapters
== About the deprecated chapters
The following chapters were relevant in Cowboy 1.0. They have
not been updated for Cowboy 2.0 yet. The information in these
chapters may or may not be useful.
include::architecture.asciidoc[Architecture]
include::broken_clients.asciidoc[Dealing with broken clients]
include::hooks.asciidoc[Hooks]
include::overview.asciidoc[Overview]