Conversation
Added a general procedure plus a procedure for specifically adding the OTP to the subject line.
WalkthroughThe pull request updates the documentation for email notifications, specifically focusing on one-time passcode (OTP) emails in passwordless authentication. The changes provide detailed guidance on customizing email content, including modifying the subject line, body, and footer. A new section has been added to explain how to include the sign-in code in the email subject line, replacing previous limitations on email content modification. Changes
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
src/content/docs/design/emails/email-notifications.mdx (2)
59-62: Add details about available placeholders and their usage.While the steps are clear, the documentation would be more helpful if it:
- Listed all available placeholders (besides
${code})- Provided example templates showing placeholder usage
- Mentioned any content restrictions or limitations
70-70: Enhance the example with realistic subject line.The current example
${code} for accessis quite basic. Consider providing a more professional example that follows email subject best practices, such as:Your sign-in code is ${code} - [Company Name]Also, mention the typical length of the code to help users design appropriate subject lines.
| It's common to want to include the sign-in code in the subject line of OTP emails, to make it visible for users in notifications. For security, Kinde displays the OTP in the email body by default, but you can override this. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add security considerations about code visibility in subject line.
While the functionality is correctly documented, consider adding a security note about the implications of making the OTP visible in email notifications (e.g., lock screen visibility, notification previews).
Deploying kinde-docs-previews with
|
| Latest commit: |
55aed3e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://084aa756.kinde-docs-previews.pages.dev |
| Branch Preview URL: | https://feat-email-content.kinde-docs-previews.pages.dev |
Added some spice about changing OTP position
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
src/content/docs/design/emails/email-notifications.mdx (1)
66-66: 🛠️ Refactor suggestionEnhance security warning for subject line OTP.
While the security warning is present, consider expanding it to include specific risks and recommendations:
- Email notifications visible on lock screens
- Preview notifications in email clients
- Notification center visibility
- Shoulder surfing risks
- Recommendation to disable email previews when using this feature
🧹 Nitpick comments (1)
src/content/docs/design/emails/email-notifications.mdx (1)
59-62: Consider adding placeholder examples for better clarity.While the instructions are clear, it would be helpful to list all available placeholders that can be used for personalization (e.g., user name, business name, etc.).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/content/docs/design/emails/email-notifications.mdx(1 hunks)
🔇 Additional comments (2)
src/content/docs/design/emails/email-notifications.mdx (2)
55-58: LGTM! Clear introduction with proper prerequisites.The section title and introduction effectively communicate the feature's scope and requirements.
68-71: LGTM! Clear instructions with good example.The steps are well-documented and the example effectively demonstrates the placeholder usage.
2 participants
Added two procedures - one general, one specifically to add OTP to subject line.
Summary by CodeRabbit