diff --git a/docs/login.md b/docs/login.md new file mode 100644 index 00000000..46817809 --- /dev/null +++ b/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) diff --git a/docs/login.puml b/docs/login.puml new file mode 100644 index 00000000..bbe65592 --- /dev/null +++ b/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 diff --git a/docs/login.svg b/docs/login.svg new file mode 100644 index 00000000..d6983c67 --- /dev/null +++ b/docs/login.svg @@ -0,0 +1 @@ +Validate server detailsLogin pageOpen login flow pageInitiate login flowOpen web browserWait for login flow resultValidate login detailsOpen QR scan pageScan QR codeStarted from QR code scanner?YesNoHas account?YesNoSelected login method?Login flowQR codeLogin successColorLogin method QR Code Login flow \ No newline at end of file