Skip to content

Commit 408bb10

Browse files
author
Rajat
committed
Added email template docs
1 parent 94cbe64 commit 408bb10

File tree

9 files changed

+139
-30
lines changed

9 files changed

+139
-30
lines changed
758 KB
Loading
572 KB
Loading
468 KB
Loading
326 KB
Loading
108 KB
Loading

apps/docs/src/config.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,10 @@ export const SIDEBAR: Sidebar = {
9696
text: "Sequences (Campaigns)",
9797
link: "en/email-marketing/sequences",
9898
},
99+
{
100+
text: "Templates",
101+
link: "en/email-marketing/templates",
102+
},
99103
{
100104
text: "Analytics",
101105
link: "en/email-marketing/analytics",

apps/docs/src/pages/en/email-marketing/broadcasts.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,9 @@ From the `Dashboard`, go to `Mails` to land on the `Broadcasts` hub. Here, you w
2020

2121
1. Click the `New broadcast` button on the right, in the `Broadcasts` hub.
2222

23-
2. Let's get acquainted with the interface. In the following image, we have marked all the sections. To see the description of a section, note its number in the screenshot and find its description below.
23+
2. You will see a template selection screen. Click the template you'd like to use as a starting point. After selecting it, You will be redirected to the broadcast management screen. The active tab will be `Compose`.
24+
25+
3. Let's get acquainted with the interface. In the following image, we have marked all the sections. To see the description of a section, note its number in the screenshot and find its description below.
2426

2527
- 1. **User Filters**: To select the users.
2628
- 2. **Total Selected Users**: The total number of selected users as per the applied filters.
@@ -33,7 +35,7 @@ From the `Dashboard`, go to `Mails` to land on the `Broadcasts` hub. Here, you w
3335

3436
![Broadcast Compose](/assets/emails/compose-broadcast.png)
3537

36-
3. Upon clicking the **Mail Edit** button, a full-page email editor will open where you can edit the email.
38+
4. Upon clicking the **Mail Edit** button, a full-page email editor will open where you can edit the email.
3739

3840
> When done, simply press the exit button. All changes are auto-saved.
3941
@@ -46,7 +48,7 @@ From the `Dashboard`, go to `Mails` to land on the `Broadcasts` hub. Here, you w
4648
- 3. **Settings Pane**: The settings pane for the email and the selected block.
4749
- 4. **Exit Button**: The email editor exit button.
4850

49-
4. If you are not yet ready to send the email or schedule it, you can simply go back to the Broadcasts hub by clicking on the `Broadcasts` breadcrumb (located at the top of the page).
51+
5. If you are not yet ready to send the email or schedule it, you can simply go back to the Broadcasts hub by clicking on the `Broadcasts` breadcrumb (located at the top of the page).
5052

5153
## Send Immediately
5254

@@ -71,6 +73,7 @@ Once an email is scheduled, you will see the time it will be sent at the bottom,
7173
Now that you understand how to send broadcasts, you can also see:
7274

7375
- [Set up automated email sequences](/en/email-marketing/sequences)
76+
- [Create re-usable templates](/en/email-marketing/templates)
7477
- [Track your email performance with analytics](/en/email-marketing/analytics)
7578

7679
## Stuck Somewhere?

apps/docs/src/pages/en/email-marketing/sequences.md

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Email sequences
2+
title: Sequences
33
description: Send email sequences to your audience
44
layout: ../../../layouts/MainLayout.astro
55
---
@@ -26,34 +26,36 @@ Here, you will see all the sequences you have configured.
2626

2727
You will be redirected to the sequence compose screen. The active tab will be `Compose`.
2828

29-
2. Let's get acquainted with the interface.
29+
2. You will see a template selection screen. Click the template you'd like to use as a starting point. After selecting it, You will be redirected to the sequence management screen. The active tab will be `Compose`.
30+
31+
3. Let's get acquainted with the interface.
3032

3133
In the following image, we have marked all the sections. To see the description of a section, note its number in the screenshot and find its description below.
3234

33-
- 1. **Sequence Name**: The internal name of the sequence.
34-
- 2. **From**: The sender's name that is displayed in the emails sent.
35-
- 3. **Entrance Condition**: The condition that triggers this sequence for a user. You can pick from the following conditions:
36-
- `Tag added`
37-
- `Tag removed`
38-
- `Product purchased`
39-
- `Subscriber added`
40-
- `Community joined`
41-
- `Community left`
42-
- 4. **Entrance Condition Data**: The exact tag or product that triggers the sequence. This field is only relevant in the context of the `Entrance Condition` field.
43-
- 5. **Save**: A button to save your changes to the sequence.
44-
- 6. **Start/Pause**: A button to start or pause the sequence. Once paused, the sequence won't be triggered for subsequent events in the system.
45-
- 7. **Email Row**: Shows an overview of one of the emails in the sequence.
46-
- 8. **New Email Button**: A button to add a new email to the sequence.
35+
![Sequence Compose](/assets/emails/compose-sequence.png)
4736

48-
![Sequence Compose](/assets/emails/compose-sequence.png)
37+
- 1. **Sequence Name**: The internal name of the sequence.
38+
- 2. **From**: The sender's name that is displayed in the emails sent.
39+
- 3. **Entrance Condition**: The condition that triggers this sequence for a user. You can pick from the following conditions:
40+
- `Tag added`
41+
- `Tag removed`
42+
- `Product purchased`
43+
- `Subscriber added`
44+
- `Community joined`
45+
- `Community left`
46+
- 4. **Entrance Condition Data**: The exact tag or product that triggers the sequence. This field is only relevant in the context of the `Entrance Condition` field.
47+
- 5. **Save**: A button to save your changes to the sequence.
48+
- 6. **Start/Pause**: A button to start or pause the sequence. Once paused, the sequence won't be triggered for subsequent events in the system.
49+
- 7. **Email Row**: Shows an overview of one of the emails in the sequence.
50+
- 8. **New Email Button**: A button to add a new email to the sequence.
4951

50-
3. Fill in the details for `Sequence Name`, `From`, `Entrance Condition`, and `Entrance Condition Data` (if applicable), then hit `Save`.
52+
4. Fill in the details for `Sequence Name`, `From`, `Entrance Condition`, and `Entrance Condition Data` (if applicable), then hit `Save`.
5153

52-
4. Start adding emails to this sequence. When you create a new sequence, an empty email is added to it by default.
54+
5. Start adding emails to this sequence. When you create a new sequence, an empty email is added to it by default.
5355

5456
![Sequence add email](/assets/emails/compose-sequence-add-email.jpeg)
5557

56-
5. Let's understand what information an email row shows:
58+
6. Let's understand what information an email row shows:
5759

5860
![Sequence email row](/assets/emails/compose-sequence-email-row.jpeg)
5961

@@ -64,9 +66,9 @@ In the following image, we have marked all the sections. To see the description
6466

6567
> The default email has `0 days` as the delay, which means the email will be sent immediately after the user enters the sequence, as it is the first email in the sequence.
6668
67-
6. To edit an email, click on the subject. This will open the email compose screen as shown below.
69+
7. To edit an email, click on the subject. This will open the email compose screen as shown below.
6870

69-
7. Let's get acquainted with the email compose interface:
71+
8. Let's get acquainted with the email compose interface:
7072

7173
- 1. **Delay**: The delay (in days) between this email and the previous one.
7274
- 2. **Subject**: The email's subject.
@@ -78,8 +80,8 @@ In the following image, we have marked all the sections. To see the description
7880

7981
![Sequence's Email Compose](/assets/emails/compose-sequence-email.png)
8082

81-
8. Edit the email's subject and status, then hit `Save`.
82-
9. Edit the email's content by clicking on the mail edit button. Upon clicking the **Mail Edit** button, a full-page email editor will open where you can edit the email.
83+
9. Edit the email's subject and status, then hit `Save`.
84+
10. Edit the email's content by clicking on the mail edit button. Upon clicking the **Mail Edit** button, a full-page email editor will open where you can edit the email.
8385

8486
> When done, simply press the exit button. All changes are auto-saved.
8587
@@ -92,18 +94,19 @@ In the following image, we have marked all the sections. To see the description
9294
- 3. **Settings Pane**: The settings pane for the email and the selected block.
9395
- 4. **Exit Button**: The email editor exit button.
9496

95-
10. To go back to the sequence settings, click on the `Compose sequence` breadcrumb as shown below.
97+
11. To go back to the sequence settings, click on the `Compose sequence` breadcrumb as shown below.
9698

9799
![Go Back to Sequence Settings](/assets/emails/back-to-sequence-breadcrumb.png)
98100

99-
11. Add more emails to the sequence by clicking on the `New email` button.
100-
12. Keep editing your sequence until you think it's perfect. Once you are satisfied with your sequence, hit the `Start` button to begin sending this sequence to users.
101+
12. Add more emails to the sequence by clicking on the `New email` button.
102+
13. Keep editing your sequence until you think it's perfect. Once you are satisfied with your sequence, hit the `Start` button to begin sending this sequence to users.
101103

102104
## Next Steps
103105

104106
Now that you understand how to create email sequences, you can also see:
105107

106108
- [Send one-off broadcasts](/en/email-marketing/broadcasts)
109+
- [Create re-usable templates](/en/email-marketing/templates)
107110
- [Track your email performance with analytics](/en/email-marketing/analytics)
108111

109112
## Stuck Somewhere?
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: Templates
3+
description: Create reusable email templates for broadcasts and sequences
4+
layout: ../../../layouts/MainLayout.astro
5+
---
6+
7+
Email templates help you build a reusable library of branded email layouts. Once saved, you can use them while creating broadcasts or sequence emails.
8+
9+
> This feature is currently in beta, which means you may encounter bugs. Please report them in our <a href="https://discord.com/invite/GR4bQsN" target="_blank">Discord</a> group if you run into any issues.
10+
11+
> **Before you start**: If your school is hosted on [courselit.app](https://courselit.app), you need to get approved to send marketing emails. [Request access here](/en/email-marketing/mail-access-request).
12+
13+
## Templates Hub
14+
15+
From the `Dashboard`, go to `Mails` and open the `Templates` tab.
16+
17+
Here, you will see all templates you have saved.
18+
19+
- If this is your first template, click `Create from template`.
20+
- If you already have templates, click `New template`.
21+
22+
![Templates Hub](/assets/emails/email-templates-hub.png)
23+
24+
## Create a Template
25+
26+
1. Open the `Templates` tab and click `Create from template` (or `New template`).
27+
2. You will be taken to the `Choose a template` screen.
28+
29+
![Templates selection screen](/assets/emails/email-template-selection-screen.png)
30+
31+
3. Review the available sections:
32+
33+
- **System**: Built-in starter templates.
34+
- **My templates**: Your saved templates.
35+
36+
4. Click any template card in the `System` section to start from it.
37+
38+
CourseLit will create a new custom template and open its `Manage` screen.
39+
40+
## Edit a Template
41+
42+
On the `Manage` screen, you can control the template settings and content.
43+
44+
![Template management](/assets/emails/email-template-manage-screen.png)
45+
46+
### Edit title
47+
48+
1. Update the `Template name`.
49+
2. Click `Save` to persist the new name.
50+
51+
### Edit content
52+
53+
1. Click the edit button on the preview (pencil icon) to open the full email editor.
54+
55+
![Template edit button](/assets/emails/email-template-manage-edit-button.png)
56+
57+
2. Edit blocks, styles, and variables in the editor.
58+
59+
![Email editor invoked via template manage screen](/assets/emails/email-editor-via-template.png)
60+
61+
> Template content is auto-saved while editing.
62+
63+
3. Click `Exit` to return to the template `Manage` screen.
64+
65+
## Use Templates in Broadcasts and Sequences
66+
67+
You can use templates while creating emails:
68+
69+
1. Go to `Mails`.
70+
2. Click `New broadcast` or `New sequence`.
71+
3. On the `Choose a template` page, select one from:
72+
73+
- `System` (starter templates)
74+
- `My templates` (your saved templates)
75+
76+
4. Continue editing subject, audience/trigger details, and send settings as needed.
77+
78+
You can also add a template to an existing sequence by creating a new email in that sequence and selecting a template.
79+
80+
## Delete a Template
81+
82+
1. Open `Mails``Templates`.
83+
2. Open the template you want to remove.
84+
3. In `Danger zone`, click `Delete template`.
85+
4. Confirm deletion in the dialog.
86+
87+
> Template deletion is permanent and cannot be undone.
88+
89+
## Next Steps
90+
91+
Now that you know how templates work, you can:
92+
93+
- [Send one-off broadcasts](/en/email-marketing/broadcasts)
94+
- [Set up automated email sequences](/en/email-marketing/sequences)
95+
- [Track your email performance with analytics](/en/email-marketing/analytics)
96+
97+
## Stuck Somewhere?
98+
99+
We are always here for you. Come chat with us in our <a href="https://discord.com/invite/GR4bQsN" target="_blank">Discord</a> channel or send a tweet to <a href="https://twitter.com/courselit" target="_blank">@CourseLit</a>.

0 commit comments

Comments
 (0)