From 96f31ecf61f850200a5ec18cfe5ccd2aff49ad61 Mon Sep 17 00:00:00 2001
From: rr-bw <102181210+rr-bw@users.noreply.github.com>
Date: Wed, 11 Sep 2024 13:13:14 -0700
Subject: [PATCH] add descriptive comment to top of HTML file

---
 .../src/angular/login/login.component.html    | 27 ++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/libs/auth/src/angular/login/login.component.html b/libs/auth/src/angular/login/login.component.html
index b934129dea..7f63afd8d0 100644
--- a/libs/auth/src/angular/login/login.component.html
+++ b/libs/auth/src/angular/login/login.component.html
@@ -1,7 +1,32 @@
+<!-- 
+  # Table of Contents
+
+    This file contains three templates, one for each visual client.
+    
+    For easy navigation, search for the following phrases:
+      Web Template
+      Browser Template
+      Desktop Template
+
+    Or simply collapse the templates you are not working on in your editor.
+
+  # UI States
+
+    Each client template is split into two UI states:
+      State 1: displays the email input field + continue button
+      State 2: displays the master password input field + login button
+    
+    These are defined by the `LoginUiState` enum:
+
+      enum LoginUiState {
+        EMAIL_ENTRY = "EmailEntry",
+        MASTER_PASSWORD_ENTRY = "MasterPasswordEntry",
+      }
+-->
+
 <!--------------------------------->
 <!--        Web Template         -->
 <!--------------------------------->
-
 <!--
     TODO-rr-bw: Clarify this comment if necessary.