From 730c44f34d6b34343ddc8723d1fa1ac700a16e4e Mon Sep 17 00:00:00 2001
From: Benjamin Wenger <ben@elixxir.ioo>
Date: Tue, 30 Aug 2022 16:57:05 -0700
Subject: [PATCH] added improved docs about package archetecture

---
 channels/manager.go | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/channels/manager.go b/channels/manager.go
index 1600271af..73d507bf3 100644
--- a/channels/manager.go
+++ b/channels/manager.go
@@ -10,6 +10,24 @@
 // replies, reactions, and eventually admin commands.
 package channels
 
+// on sending, data propagates as follows:
+// Send function (Example: SendMessage) - > SendGeneric ->
+//     Broadcast.BroadcastWithAssembler -> cmix.SendWithAssembler
+
+// on receiving messages propagate as follows:
+// cmix message pickup (by service)- > userListener ->
+//     events.triggerEvent -> messageTypeHandler (example: Text) ->
+//     eventModel (example: ReceiveMessage)
+
+// on sendingAdmin, data propagates as follows:
+// Send function - > SendAdminGeneric ->
+//     Broadcast.BroadcastAsymmetricWithAssembler -> cmix.SendWithAssembler
+
+// on receiving admin messages propagate as follows:
+// cmix message pickup (by service)- > adminListener ->
+//     events.triggerAdminEvent -> messageTypeHandler (example: Text) ->
+//     eventModel (example: ReceiveMessage)
+
 import (
 	"gitlab.com/elixxir/client/broadcast"
 	"gitlab.com/elixxir/client/storage/versioned"
-- 
GitLab