refactor docs
This commit is contained in:
37
docs/templates/enrollment_diagram.template.md
vendored
Normal file
37
docs/templates/enrollment_diagram.template.md
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
# nKode Enrollment
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant User
|
||||
participant Client
|
||||
participant Server
|
||||
Note over User,Server: Enrollment
|
||||
Client->>User: Signup Form
|
||||
Note left of User: email: {{ email }}
|
||||
User->>Client: Submit Email
|
||||
Client->>+Server: Signup Session: {{ email }}
|
||||
Server->>Server: Create Signup Session
|
||||
Note over User,Server: Set nKode
|
||||
Server-->>-Client: signup_session_id, set_keypad, icons
|
||||
Note left of Server: signup_session_id:<br/>{{ signup_session_id }}
|
||||
Note left of Server: set_keypad:<br/>{{set_keypad}}
|
||||
Note left of Server: Icons:<br/>{{keypad_icons}}
|
||||
Client->>Client: Order Icons by keypad
|
||||
Client->>User: Display Keypad
|
||||
Note left of Client: {{ ordered_keypad }}
|
||||
Note left of User: User icons: {{ passcode_user_icons }}
|
||||
User->>Client: Set Key Selection: {{ selected_keys_set }}
|
||||
Client->>+Server: Set nKode:<br/>{{ signup_session_id }}<br/>{{ selected_keys_set }}
|
||||
Server->>Server: Disperse Set Keypad
|
||||
Note over User,Server: Confirm nKode
|
||||
Server-->>-Client: signup_session_id, confirm_keypad, icons
|
||||
Note left of Server: signup_session_id:<br/>{{ signup_session_id }}
|
||||
Note left of Server: confirm_keypad:<br/>{{confirm_keypad}}
|
||||
Client->>Client: Order Icons by keypad
|
||||
Client->>User: Display Keypad
|
||||
Note left of Client: {{ confirm_ordered_keypad }}
|
||||
Note left of User: User icons: {{ passcode_user_icons }}
|
||||
User->>Client: Key Selection: {{ confirm_key_selection }}
|
||||
Client->>+Server: Confirm nKode:<br/>{{ signup_session_id }}<br/>{{ confirm_key_selection }}
|
||||
Server->>Server: Create User
|
||||
Server-->>-Client: Success
|
||||
```
|
||||
22
docs/templates/login_diagram.template.md
vendored
Normal file
22
docs/templates/login_diagram.template.md
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
# nKode Login
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant User
|
||||
participant Client
|
||||
participant Server
|
||||
Note over User,Server: Login
|
||||
Client->>User: Login Form
|
||||
Note left of User: email: {{ email }}
|
||||
User->>Server: Submit Email
|
||||
Server->>Client: login_keypad, icons
|
||||
Note left of Server: Login Keypad:<br/>{{ login_keypad }}
|
||||
Note left of Server: Icons:<br/>{{ keypad_icons }}
|
||||
Client->>Client: Order Icons
|
||||
Client->>User: Display Keypad
|
||||
Note left of Client: {{ ordered_login_icons }}
|
||||
Note left of User: User passcode icons: {{ passcode_user_icons }}
|
||||
User->>Client: Selected Keys<br/>{{selected_keys_login}}
|
||||
Client->>Server: Login:<br/>email: {{email}}<br/>selected_keys: {{selected_keys_login}}
|
||||
Server-->>Client: Success
|
||||
```
|
||||
Reference in New Issue
Block a user