Skip to content

Commit bac54d0

Browse files
Update understand-page-design.mdx
Updated list with Dave's definitions
1 parent 1528717 commit bac54d0

File tree

1 file changed

+49
-51
lines changed

1 file changed

+49
-51
lines changed

src/content/docs/design/customize-with-code/understand-page-design.mdx

Lines changed: 49 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -189,79 +189,77 @@ Once you start customizing pages, it's on you not to break them. We recommend al
189189
190190
</Aside>
191191
192-
Common routes
192+
### Common pages
193193
194-
`(default)` - The page template that will be used for all Kinde hosted pages when a specific one cannot be found.
194+
These are the most frequently used or fallback pages.
195195
196-
`(register)` - The sign up page
196+
* `(default)` – Fallback template used when a specific page is not found.
197+
* `(register)` – The sign-up page.
198+
* `(login)` – The sign-in page.
199+
* `(index)` – Landing page when visiting the root domain (e.g. `https://<yourdomain>.kinde.com`).
197200

198-
`(login)` - The sign in page
201+
### Authentication
199202

200-
`(index)` - If someone visits the root domain for your business, e.g. `https://<yourdomain>.kinde.com`
203+
Pages involved in initiating authentication flows.
204+
* `(register)` – The sign-up page.
205+
* `(login)` – The sign-in page.
206+
* `(sso_home_realm)` – Displayed when a user selects “Continue with SSO” to choose their identity provider.
207+
* `(provide_email)` – Shown when using a social login provider that does not return an email address.
208+
* `(clickwrap)` – Displays terms and conditions or agreements that must be accepted.
201209

202-
Errors
210+
### Password flows
203211

204-
`(account_locked)`
212+
Used in password-based authentication and recovery.
205213

206-
`(account_not_found)`
214+
* `(verify_password)` – Shown during sign-in when using a password-based method.
215+
* `(set_password)` – Shown during a password-based sign-up flow.
216+
* `(reset_password_verify_email_otp)` – First step of the reset flow where the user verifies identity using an email OTP.
217+
* `(reset_password)` – Password entry screen shown after verification during the reset flow.
207218

208-
`(error)`
219+
### One-Time Passcode (OTP) verification
209220

210-
`(invalid_redirect_url)`
221+
Used in sign-in and sign-up flows with OTP (email or phone).
211222

212-
Authentication & MFA
223+
* `(sign_in_use_email_otp)` – Sign in with a one-time email code.
224+
* `(sign_up_use_email_otp)` – Sign up with a one-time email code.
225+
* `(sign_in_sign_up_use_phone_otp)` – Sign in or sign up with a one-time phone code.
213226

214-
`(clickwrap)`
227+
### Multi-Factor Authentication (MFA)
215228

216-
`(sso_home_realm)`
229+
Shown after primary authentication when MFA is required or being set up.
217230

218-
`(provide_email)`
231+
* `(mfa_method_selection)` – User selects their preferred MFA method.
232+
* `(mfa_authenticator_app)` – Setup screen for using an authenticator app.
233+
* `(mfa_setup_email)` – Setup screen for email-based MFA.
234+
* `(mfa_setup_phone)` – Setup screen for phone-based MFA.
235+
* `(mfa_use_email_otp)` – Enter a one-time email code for MFA.
236+
* `(mfa_use_phone_otp)` – Enter a one-time phone code for MFA.
237+
* `(mfa_use_recovery_code)` – Enter a recovery code if unable to use other MFA methods.
238+
* `(mfa_view_recovery_codes)` – View and save MFA recovery codes.
219239

220-
`(mfa_authenticator_app)`
240+
### Billing (coming soon)
221241

222-
`(mfa_method_selection)`
242+
Pages related to choosing a plan and making a payment.
223243

224-
`(mfa_setup_email)`
244+
* `(choose_plan)` – User selects a subscription plan.
245+
* `(collect_payment_details)` – User enters billing information.
246+
* `(subscription_success)` – Confirmation page shown after successful subscription.
225247

226-
`(mfa_setup_phone)`
248+
### Early access
227249

228-
`(mfa_use_email_otp)`
250+
Pages for gated access to your product before full launch.
229251

230-
`(mfa_use_phone_otp)`
252+
* `(request_access)` – Request early access to your product.
253+
* `(request_access_success)` – Confirmation page after a request is submitted.
231254

232-
`(mfa_use_recovery_code)`
255+
### Error pages
233256

234-
`(mfa_view_recovery_codes)`
257+
Shown when a user encounters an error state.
235258

236-
Passwords
237-
238-
`(reset_password)`
239-
240-
`(reset_password_verify_email_otp)`
241-
242-
`(set_password)`
243-
244-
`(verify_password)`
245-
246-
Verify code
247-
248-
`(sign_in_sign_up_use_phone_otp)`
249-
250-
`(sign_in_use_email_otp)`
251-
252-
`(sign_up_use_email_otp)`
253-
254-
`(subscription_success)`
255-
256-
Other routes
257-
258-
`(request_access)` - before you launch and want to collect subscribers
259-
260-
`(request_access_success)`
261-
262-
`(choose_plan)` - coming soon, relates to billing
263-
264-
`(collect_payment_details)` - coming soon, related to billing
259+
* `(account_locked)` – The user’s account has been locked.
260+
* `(account_not_found)` – No account was found for the entered credentials.
261+
* `(invalid_redirect_url)` – The redirect URL is invalid or not on the allowed list.
262+
* `(error)` – Generic error screen.
265263

266264
If you want specific customization for a page not listed here, reach out and let us know.
267265

0 commit comments

Comments
 (0)