Add screenshots and update doc for supported policies (#197)

ValueMelody · Dec 3, 2024 · 51d7a7e · 51d7a7e
1 parent a71ae7d
commit 51d7a7e
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 0 deletions.
diff --git a/docs/q&a.md b/docs/q&a.md
@@ -126,3 +126,8 @@ loginRedirect({
   policy: 'change_password',
 })
 ```
+- Supported Policies
+  -	sign_in_or_sign_up: Default policy.
+  -	change_password: Allows users to change their password (for password-based users only). Requires ENABLE_PASSWORD_RESET to be set to true in the configuration.
+  -	change_email: Allows users to change their email address (for password-based users only). Requires ENABLE_EMAIL_VERIFICATION to be set to true in the configuration.
+  -	reset_mfa: Allows users to reset their enrolled MFA (Multi-Factor Authentication) method.
diff --git a/docs/screenshots.md b/docs/screenshots.md
@@ -42,6 +42,15 @@ These screenshots showcase various pages and emails related to identity system a
 
 ![Reset Password 2](https://raw.githubusercontent.com/ValueMelody/melody-auth/main/docs/screenshots/reset_password_2.jpeg)
 
+### Change Email Policy
+![Change Email Policy](https://raw.githubusercontent.com/ValueMelody/melody-auth/main/docs/screenshots/change_email_policy.jpeg)
+
+### Change Password Policy
+![Change Password Policy](https://raw.githubusercontent.com/ValueMelody/melody-auth/main/docs/screenshots/change_password_policy.jpeg)
+
+### Reset MFA Policy
+![Reset MFA Policy](https://raw.githubusercontent.com/ValueMelody/melody-auth/main/docs/screenshots/reset_mfa_policy.jpeg)
+
 ## Admin Panel Pages
 
 ### Dashboard

diff --git a/docs/screenshots/change_email_policy.jpeg b/docs/screenshots/change_email_policy.jpeg
diff --git a/docs/screenshots/change_password_policy.jpeg b/docs/screenshots/change_password_policy.jpeg
diff --git a/docs/screenshots/reset_mfa_policy.jpeg b/docs/screenshots/reset_mfa_policy.jpeg