From 429ec00caf2bae8ee9f0d4384201e8a552e21948 Mon Sep 17 00:00:00 2001
From: Janne Mareike Koschinski <janne@kuschku.de>
Date: Mon, 23 Dec 2019 19:14:29 +0100
Subject: [PATCH] improved documentation
---
docs/protocol/layers/framing.md | 6 ++++++
docs/protocol/layers/message.md | 5 ++++-
docs/protocol/layers/overview.md | 6 ------
mkdocs.yml | 1 -
4 files changed, 10 insertions(+), 8 deletions(-)
delete mode 100644 docs/protocol/layers/overview.md
diff --git a/docs/protocol/layers/framing.md b/docs/protocol/layers/framing.md
index 792a87c..8f51822 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 127c453..61e0c26 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 f5d9f49..0000000
--- 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 62c5ec1..775fd0d 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":
--
GitLab