From dbaa1dfe7bbdefabf190c9ccce3627338fbe8d88 Mon Sep 17 00:00:00 2001
From: Nayam Amarshe <25067102+NayamAmarshe@users.noreply.github.com>
Date: Thu, 25 Apr 2024 01:32:22 +0530
Subject: [PATCH] Add documentation

---
 electron/utils/config-variables.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/electron/utils/config-variables.ts b/electron/utils/config-variables.ts
index 6a2f3d9..913ff36 100644
--- a/electron/utils/config-variables.ts
+++ b/electron/utils/config-variables.ts
@@ -1,3 +1,8 @@
+/**
+ * This file contains all the global local storage variables that need to be accessed on startup or during the app lifecycle. These are the variables that are not sent by the renderer process but are the localstorage variables used by the main process.
+ * Our goal is to send as many variables as possible from the renderer process to the main process to avoid using local storage variables.
+ */
+
 import { ChildProcessWithoutNullStreams } from "child_process";
 import { getMainWindow } from "../main-window";
 import logit from "./logit";