Skip to content

Conversation

saif-at-scalekit
Copy link
Collaborator

@saif-at-scalekit saif-at-scalekit commented Sep 8, 2025

  • Introduced a new image asset for custom email templates to enhance visual representation in the guide.
  • Updated the custom email templates documentation to include the new image, improving user understanding of the feature.
    View the preview

* Introduced a new image asset for custom email templates to enhance visual representation in the guide.
* Updated the custom email templates documentation to include the new image, improving user understanding of the feature.
…mplates guide

* Added a new redirect for the custom email templates guide to improve navigation.
* Updated sidebar configuration to include the custom email templates guide under relevant sections, enhancing user access to documentation.
* Introduced the custom email templates documentation, detailing customization options for email branding and content.
@saif-at-scalekit saif-at-scalekit marked this pull request as ready for review September 8, 2025 16:57
@amitash1912
Copy link
Collaborator

image

The above section can be removed completely. And be replaced with section for Available template variables:
image

@amitash1912
Copy link
Collaborator

amitash1912 commented Sep 8, 2025

Can we add one-line description for application, user, organization and contextual variable section, like:
Application variables: Use application variables to add application related data to template.
Contextual variables: These variables work are the ones that work with only the given template. These change for each template.

@amitash1912
Copy link
Collaborator

image Remove these 2 from here as they are not part of template customization.

@amitash1912
Copy link
Collaborator

Can we give more detailed explanation for HTML and plain text content, when both are used.
image

* Expanded the section on HTML and plain text bodies to include best practices for email content.
* Introduced a new section on available template variables, detailing application, contextual, organization, and user variables for personalization.
* Added tips and notes to improve user understanding of template variable usage and email customization.
* Improved overall structure and clarity of the guide for better navigation and comprehension.
… and clarity

- Reorganize template variables section for better readability
- Add note about requiring custom email provider for custom templates
- Improve explanations for HTML/plain text versions
- Restructure contextual variables section with better examples
@amitash1912
Copy link
Collaborator

@saif-at-scalekit Can you update all images for custom email templates with newer dashboard images?

Once done, can you please provide preview link?

@saif-at-scalekit
Copy link
Collaborator Author

Thanks for spotting this gap, @amitash1912

The screenshots are now refreshed. The top description is updated to contain the preview

@amitash1912
Copy link
Collaborator

image What is this showing up?

@amitash1912
Copy link
Collaborator

Can you please add reference for JET syntax that can be used in our email templates?

@amitash1912
Copy link
Collaborator

image Any reason for blurry image for workspace/env? It looks a bit unprofessional.

@saif-at-scalekit
Copy link
Collaborator Author

Any reason for blurry image for workspace/env?

This is a common approach to hide any identifying information. This shouldn't matter much. An alternative option would be to always maintain a separate workspace specifically for this purposes. This we can pursue in the future.

Can you please add reference for JET syntax that can be used in our email templates?

Must be added by now.

What is this showing up?

I'm experimenting to introduce slight quizzes to allow users to test their knowledge. Keep it more playful yet give a sense of learning/accomplishment.

@amitash1912
Copy link
Collaborator

amitash1912 commented Sep 30, 2025

@saif-at-scalekit expiry_time_relative does not return timstamp. It returns value in format of date like 14 days, 6 hours, 50 min, etc. Can you change this example:
image

You can add an example for org_name in user invite template. If org_name exists, then show text: "You have been invited to join <org_name> organization in B2B app." If org_name absent, then show text: "You have been invited to B2B app."

@amitash1912
Copy link
Collaborator

amitash1912 commented Sep 30, 2025

@saif-at-scalekit Why is this section at bottom?
image

I understand that you want to have some user interaction on docs. But in the current form, it seems more like a step that I need to do as part of implementation of custom email templates.

@amitash1912
Copy link
Collaborator

@saif-at-scalekit This is incorrect:
"The variables below apply to the OTP and magic link login template shown here. Other email templates may expose different variables."

Can we replace this line with below line:
"The variables below apply to all Scalekit templates."

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants