From b5a9ecf5e8b7f7e962474469ba591216e07c7dd9 Mon Sep 17 00:00:00 2001
From: Erik Brakkee <erik@brakkee.org>
Date: Sat, 17 Aug 2024 10:41:22 +0200
Subject: [PATCH] more docs.

---
 pkg/comms/doc.go  | 5 +++++
 pkg/models/doc.go | 2 ++
 2 files changed, 7 insertions(+)
 create mode 100644 pkg/comms/doc.go
 create mode 100644 pkg/models/doc.go

diff --git a/pkg/comms/doc.go b/pkg/comms/doc.go
new file mode 100644
index 0000000..a9e7162
--- /dev/null
+++ b/pkg/comms/doc.go
@@ -0,0 +1,5 @@
+// Communication between server on the one hand and client (wsproxy), and agent on the other.
+// This is based on GOB and requires sends and receives to match. Keeping the code for sending
+// and receiving together makes it easier to maintain since this code is tightly couopled and
+// in this way not spread out.
+package comms
diff --git a/pkg/models/doc.go b/pkg/models/doc.go
new file mode 100644
index 0000000..de3625c
--- /dev/null
+++ b/pkg/models/doc.go
@@ -0,0 +1,2 @@
+// shared state information between converge server, web ui, and prometheus integration.
+package models