diff --git a/docs/protocol/layers/framing.md b/docs/protocol/layers/framing.md index 792a87cc76f387885f5262fd5fb36c76cd3225b5..8f51822c7359a419978c86d89da98f8db69efb84 100644 --- a/docs/protocol/layers/framing.md +++ b/docs/protocol/layers/framing.md @@ -1,5 +1,11 @@ # Framing Layer +This describes the lowest layer of the protocol, on which the +[Message Layer](message.md) rests. + +This layer is named the "framing" layer, because its only purpose is to frame +messages of higher layers and negotiate basic features for this use case. + ## State Machine The framing layer has two possible states: `HANDSHAKE` and `CONNECTED`. diff --git a/docs/protocol/layers/message.md b/docs/protocol/layers/message.md index 127c453f674a345770d056595b5f70c73477be13..61e0c2675fcb92f5886082dd6b9a29f846cda69d 100644 --- a/docs/protocol/layers/message.md +++ b/docs/protocol/layers/message.md @@ -1,8 +1,11 @@ # Message Layer +This describes the second layer of the protocol, the message layer, which rests +upon the [Framing Layer](framing.md). + ## State Machine -The framing layer has two possible states: `HANDSHAKE` and `CONNECTED`. +The message layer has two possible states: `HANDSHAKE` and `CONNECTED`. It starts off in `HANDSHAKE` state. ## Handshake State diff --git a/docs/protocol/layers/overview.md b/docs/protocol/layers/overview.md deleted file mode 100644 index f5d9f4984d0db1e5a3577ab1fa65fddc17477627..0000000000000000000000000000000000000000 --- a/docs/protocol/layers/overview.md +++ /dev/null @@ -1,6 +0,0 @@ -# Layers - -The lowest layer is the [Framing Layer](framing.md), on top of that rests the -[Message Layer](message.md). - -How to interpret those messages is going to be described at a later time. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 62c5ec1eb54fd0c308fc0d45545ab38b2bffb95a..775fd0df20fd4e6e76a8ee26b49fb02cf55625bc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,7 +13,6 @@ nav: - "Upgrade Guide": usage/upgrade_guide.md - "Protocol": - "Layers": - - "Overview": protocol/layers/overview.md - "Framing": protocol/layers/framing.md - "Message": protocol/layers/message.md - "Serialization":