Skip to content

Commit f549a9a

Browse files
authored
docs: add bloom emails (#14895)
1 parent 94781d2 commit f549a9a

File tree

7 files changed

+53
-30
lines changed

7 files changed

+53
-30
lines changed

www/apps/bloom/app/developers/_email-templates/page.mdx renamed to www/apps/bloom/app/developers/email-templates/page.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,12 @@ This template component uses React Email components to structure the email and a
315315

316316
If you're using the [Code Editor](../code-editor/page.mdx) feature, save the template's file to commit it to the GitHub repository of the project. If you've [exported your project to GitHub](../export-to-github/page.mdx) and you created the template locally, make sure to push it to GitHub.
317317

318-
Then, in your Bloom project's interface, click on <InProductAction product={"bloom"} type={"MEDUSA_AI_OPEN_PANE"} data={{ pane: "emails" }}>**Emails**</InProductAction> at the top of the preview. This will open the email previewer where you can switch between your email templates and see how they look with demo data.
318+
Then, in your Bloom project's interface, open your <InProductAction product={"bloom"} type={"MEDUSA_AI_OPEN_PANE"} data={{ pane: "emails" }}>**Emails**</InProductAction> tab:
319+
320+
1. Press <Kbd>{getOsShortcut()}</Kbd> + <Kbd>k</Kbd> to open the preview tab switcher.
321+
2. Select the "Emails" tab from the list.
322+
323+
This will open the email previewer where you can view your email template and see how it looks on desktop and mobile.
319324

320325
{/* TODO: add screenshot */}
321326

www/apps/bloom/app/features/_emails/page.mdx renamed to www/apps/bloom/app/features/emails/page.mdx

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ When you publish your store, Bloom automatically sends the emails to customers b
2323

2424
<Note>
2525

26-
Emails only send from your live store. You can only send test emails in preview mode.
26+
Emails only send from your live store. You can only send test emails in preview mode to yourself or anyone in your [team](../../organization-management/team/page.mdx).
2727

2828
</Note>
2929

@@ -51,13 +51,16 @@ To open the <InProductAction product={"bloom"} type={"MEDUSA_AI_OPEN_PANE"} data
5151
1. Press <Kbd>{getOsShortcut()}</Kbd> + <Kbd>k</Kbd> to open the preview tab switcher.
5252
2. Select the "Emails" tab from the list.
5353

54-
This will open the email preview where you can switch between email templates, see how they look on desktop and mobile, and make changes to the design and content.
54+
This will open the email preview where you can:
55+
56+
1. Switch between email templates, see how they look on desktop and mobile, and make changes to the design and content.
57+
2. Copy prompts for common email templates to ask Bloom to create them for you.
5558

5659
### Choose Email Template
5760

58-
To choose which email template to preview, use the dropdown at the top right of the preview. This dropdown lists all the email templates Bloom has created for your store.
61+
If you have email templates, you can preview them at the left side of the Emails tab.
5962

60-
Once you choose a template, a preview of the template will show in the main area.
63+
Clicking the template will preview its content in the main area on the right.
6164

6265
{/* TODO: Screenshot of template dropdown */}
6366

@@ -100,22 +103,21 @@ hard to click. Can you make the text bigger and the buttons larger on mobile?
100103

101104
Bloom will see the issue from the screenshot and update the template to fix the mobile design.
102105

103-
### Send Test Emails
106+
---
104107

105-
After previewing the email template and making any necessary changes, you can send a test email to yourself to see how it looks in your inbox. This is necessary to see how the email realistically looks to customers and to check that all links and images work correctly.
108+
## Start Sending Emails
106109

107-
To send a test email:
110+
Once you're done building your email templates with Bloom, you can test them in preview mode before publishing them to your live store.
108111

109-
1. In the Email preview, click the "Test" button at the top right.
110-
2. Enter your email address when prompted and click "Send Test".
112+
### Send Test Emails
111113

112-
Bloom will send a test email to your inbox so you can see how it looks in your email app. If there are any issues with the email, take a screenshot and ask Bloom to fix them.
114+
To send a test email, simulate the flow that triggers the email in preview mode. You can only send test emails to yourself or anyone in your [team](../../organization-management/team/page.mdx).
113115

114-
---
116+
For example, if you created an order confirmation email, you can try placing an order in preview mode using your email address. This will trigger the order confirmation email to be sent to you as a test.
115117

116-
## Send Emails to Customers
118+
### Publish Email Templates
117119

118-
Once you're done building your email templates with Bloom, you need to publish the changes to your live store for customers to start receiving the emails.
120+
Once you're satisfied with your email templates and have tested them, you need to publish the changes to your live store for customers and admin users to start receiving the emails.
119121

120122
To publish the changes, click the "Publish" button at the top right of the preview and confirm publishing.
121123

www/apps/bloom/app/going-live/page.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,15 @@ Ask Bloom to integrate Stripe for payments, Klaviyo for email marketing, Slack f
9393

9494
See the [Integrations](../features/integrations/page.mdx) guide for instructions on integrating services with Bloom.
9595

96-
{/* ### 1.6. Set Up Transactional Emails
96+
### 1.6. Set Up Transactional Emails
9797

9898
Bloom allows you to design and customize transactional emails that customers receive for important events like order confirmations and shipping notifications.
9999

100100
Before publishing, make sure transactional emails are set up and customized to match your brand. This ensures customers receive professional and branded communications from your store.
101101

102-
See the [Emails](../features/emails/page.mdx) guide for detailed setup instructions. */}
102+
See the [Emails](../features/emails/page.mdx) guide for detailed setup instructions.
103103

104-
### 1.6. Optimize for Search Engines
104+
### 1.7. Optimize for Search Engines
105105

106106
Search Engine Optimization (SEO) is crucial for helping customers find your store through search engines like Google. Before publishing, optimize your store's SEO to improve visibility and attract organic traffic.
107107

@@ -121,7 +121,7 @@ And more.
121121

122122
You can also upload images and ask Bloom to use them for OpenGraph meta tags, which improve how your store looks when shared on social media.
123123

124-
### 1.7. Test Mobile Experience
124+
### 1.8. Test Mobile Experience
125125

126126
Most customers shop from their phones, so it's crucial to ensure your store looks and works great on mobile devices before publishing.
127127

www/apps/bloom/generated/edit-dates.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ export const generatedEditDates = {
4141
"app/organization-management/team/page.mdx": "2026-02-18T10:24:38.994Z",
4242
"app/features/team-collaboration/page.mdx": "2026-02-17T14:30:51.065Z",
4343
"app/preview-tabs/page.mdx": "2026-02-24T08:56:07.482Z",
44-
"app/developers/_email-templates/page.mdx": "2026-02-16T15:35:31.906Z",
45-
"app/features/_emails/page.mdx": "2026-02-18T13:53:16.758Z",
44+
"app/developers/email-templates/page.mdx": "2026-03-16T13:19:23.033Z",
45+
"app/features/emails/page.mdx": "2026-03-16T13:10:48.784Z",
4646
"app/features/integrations/guides/cookiebot/page.mdx": "2026-03-18T08:23:24.558Z",
4747
"app/features/integrations/guides/klaviyo/page.mdx": "2026-03-18T08:33:25.354Z",
4848
"app/features/integrations/guides/slack/page.mdx": "2026-03-18T08:33:20.171Z",

www/apps/bloom/generated/sidebar.mjs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,14 @@ export const generatedSidebars = [
170170
"path": "/features/view-switcher",
171171
"children": []
172172
},
173+
{
174+
"loaded": true,
175+
"isPathHref": true,
176+
"type": "link",
177+
"title": "Emails",
178+
"path": "/features/emails",
179+
"children": []
180+
},
173181
{
174182
"loaded": true,
175183
"isPathHref": true,
@@ -373,6 +381,14 @@ export const generatedSidebars = [
373381
"title": "Environment Variables",
374382
"path": "/developers/environment-variables",
375383
"children": []
384+
},
385+
{
386+
"loaded": true,
387+
"isPathHref": true,
388+
"type": "link",
389+
"title": "Email Templates",
390+
"path": "/developers/email-templates",
391+
"children": []
376392
}
377393
]
378394
},

www/apps/bloom/sidebars/developers.mjs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ export const developersSidebar = [
1919
title: "Environment Variables",
2020
path: "/developers/environment-variables",
2121
},
22-
// {
23-
// type: "link",
24-
// title: "Email Templates",
25-
// path: "/developers/email-templates",
26-
// },
22+
{
23+
type: "link",
24+
title: "Email Templates",
25+
path: "/developers/email-templates",
26+
},
2727
],
2828
},
2929
]

www/apps/bloom/sidebars/features.mjs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ export const featuresSidebar = [
1919
title: "View Switcher",
2020
path: "/features/view-switcher",
2121
},
22-
// {
23-
// type: "link",
24-
// title: "Emails",
25-
// path: "/features/emails",
26-
// },
22+
{
23+
type: "link",
24+
title: "Emails",
25+
path: "/features/emails",
26+
},
2727
{
2828
type: "link",
2929
title: "Integrations",

0 commit comments

Comments
 (0)