From 27f24ca5659e309a8ddfb883340effb1b3fdde5b Mon Sep 17 00:00:00 2001
From: Robin <robin@robin.town>
Date: Tue, 21 Oct 2025 00:07:48 -0400
Subject: [PATCH] Document CallViewModel and some terms used

---
 src/state/CallViewModel.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/state/CallViewModel.ts b/src/state/CallViewModel.ts
index e003ce3b..e1f92ffa 100644
--- a/src/state/CallViewModel.ts
+++ b/src/state/CallViewModel.ts
@@ -171,6 +171,14 @@ interface LayoutScanState {
 
 type MediaItem = UserMedia | ScreenShare;
 
+/**
+ * A view model providing all the application logic needed to show the in-call
+ * UI (may eventually be expanded to cover the lobby and feedback screens in the
+ * future).
+ */
+// Throughout this class and related code we must distinguish between MatrixRTC
+// state and LiveKit state. We use the common terminology of room "members", RTC
+// "memberships", and LiveKit "participants".
 export class CallViewModel {
   private readonly urlParams = getUrlParams();