Browse Source

docs: Document login user flow

pull/348/head
jld3103 2 years ago
parent
commit
1f7da6ab77
No known key found for this signature in database
GPG Key ID: 9062417B9E8EB7B3
  1. 5
      docs/login.md
  2. 36
      docs/login.puml
  3. 1
      docs/login.svg

5
docs/login.md

@ -0,0 +1,5 @@
# Login user flow
This diagram displays the user flow for logging into the app. This is not how it currently works, but how it should work at some point.
![Login user flow diagram](login.svg)

36
docs/login.puml

@ -0,0 +1,36 @@
@startuml login
(*) if "Started from QR code scanner?" then
-[#red]->[Yes] "Validate server details"
else
->[No] if "Has account?" then
-->[Yes] (*)
else
-->[No] "Login page"
endif
endif
if "Selected login method?" then
-[#blue]->[Login flow] "Validate server details"
-[#blue]-> "Open login flow page"
-[#blue]-> "Initiate login flow"
-[#blue]-> "Open web browser"
-[#blue]-> "Wait for login flow result"
-[#blue]-> "Validate login details"
else
-[#red]->[QR code] "Open QR scan page"
-[#red]-> "Scan QR code"
-[#red]-> "Validate server details"
-[#red]-> "Validate login details"
endif
-->[Login success] (*)
legend left
|Color | Login method |
|<#red> | QR Code |
|<#blue>| Login flow |
endlegend
@enduml

1
docs/login.svg

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 15 KiB

Loading…
Cancel
Save