Merge pull request #4 from HAW-RN/initial

Improve the output PDF & Meeting Notes

.github/workflows/build.yml

@@ -23,11 +23,11 @@ jobs:
           input_path: merged_output/output.md
           output_dir: pdfs
           images_dir: protocol/images
+          theme: ./pico.min.css
           # for example <img src="./images/file-name.png">
           image_import: ./images
           # Default is true, can set to false to only get PDF files
           build_html: false
-          table_of_contents: true
       - uses: actions/upload-artifact@v4
         with:
           name: protocol

meetings/20240531.md

@@ -0,0 +1,69 @@
+# Date: 31.03.2024
+
+# Participants
+- Tom Hert
+- Daniil Khoma
+- Laurin Zacharias
+- Tom Westendorf
+- Eike Balling
+- Jeremy Reimers
+- Alexander Kelsch
+- Bastian Basler
+- Ruben Marin Grez
+- Tim Hagedorn
+- Michael German
+- Andrii Lysyi
+
+# Agenda
+
+- Showcase of the MVP of each team
+
+# Recap
+
+## Routing protocol
+
+- Showcase of routing protocol MVP
+- Do we need to specify the port
+  - Answer: Yes, makes sense to specify the port
+- Move packet type to common header
+
+
+## Routed protocol
+
+- Showcase of routed protocol MVP
+  - Max size, example, etc.
+- Move checksum to common header
+
+## Coding
+
+- We use JSON
+- What to do next [See org issues]
+- Have a basic common header ala:
+```json
+{
+    "type": "TYPE",
+    "version": 1,
+    "checksum": "HASH",
+    "payload": {
+        "ACTUAL_DATA": "ACTUAL_DATA",
+        "MORE_DATA": "MORE_DATA",
+        "EVEN_MORE_DATA": "EVEN_MORE_DATA",
+    }
+}
+```
+
+## Use Case
+
+- Showcase of use cases
+- Consider implementing a client-side "exit" packet
+    - Makes sense, only works on graceful shutdown
+    - Can be used to signal the end of a connection
+        - Otherwise, the connection would be closed by the server
+
+
+## Organizational issues
+
+- Use Cases and Coding are both at the end of what they have to do [Maybe consolidate teams?]
+- Routed protocol also close to done
+- Showcase our work on monday
+- Ask Becke for how he would imagine tests for our project

protocol/01_introduction.md

@@ -2,4 +2,4 @@
 
 ## Purpose
 
-## General requirements
+## General requirements

protocol/03_encoding.md

@@ -4,4 +4,4 @@
 
 ## Format
 
-## Example
+## Example

protocol/04_routing_protocol.md

@@ -6,4 +6,4 @@
 
 ## Procedure
 
-## Example
+## Example

protocol/05_routed_protocol.md

@@ -16,6 +16,7 @@ The task of the routed protocol is to transfer chat messages from one client to
 ## Procedure
 
 ## Example
+
 ```json
 {
     "package_type":       "data_message"
@@ -34,4 +35,4 @@ Source Port: Port of the sender
 Destination IP: IPv4 address of the destination
 Destination Port: Port of the destination
 TTL: time to live of the package. maximum of 16 to 64
-Data: message value limited to 128 chars in utf-8 for smaller package size
+Data: message value limited to 128 chars in utf-8 for smaller package size

protocol/06_appendix.md

@@ -2,4 +2,4 @@
 
 ## Glossary
 
-## References
+## References