add descriptive comment to top of HTML file

This commit is contained in:
rr-bw 2024-09-11 13:13:14 -07:00
parent 234191e809
commit 96f31ecf61
No known key found for this signature in database
GPG Key ID: 3FA13C3ADEE51D5D
1 changed files with 26 additions and 1 deletions

View File

@ -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 --> <!-- Web Template -->
<!---------------------------------> <!--------------------------------->
<!-- <!--
TODO-rr-bw: Clarify this comment if necessary. TODO-rr-bw: Clarify this comment if necessary.