From 9313fc55a953efbdd5815dc35c493daac6fe2d53 Mon Sep 17 00:00:00 2001 From: Rajat Saxena Date: Fri, 30 Aug 2024 23:35:51 +0530 Subject: [PATCH] Prettier fixes --- .../en/email-marketing/broadcast-mails.md | 22 ++++---- .../pages/en/email-marketing/introduction.md | 9 ++-- .../en/email-marketing/mail-access-request.md | 6 +-- .../src/pages/en/email-marketing/sequences.md | 50 ++++++++++--------- apps/docs/src/pages/en/products/section.md | 7 +-- .../src/pages/en/self-hosting/self-host.md | 1 - apps/docs/src/styles/index.css | 2 +- 7 files changed, 51 insertions(+), 46 deletions(-) diff --git a/apps/docs/src/pages/en/email-marketing/broadcast-mails.md b/apps/docs/src/pages/en/email-marketing/broadcast-mails.md index 11bf8118c..49f7e06e9 100644 --- a/apps/docs/src/pages/en/email-marketing/broadcast-mails.md +++ b/apps/docs/src/pages/en/email-marketing/broadcast-mails.md @@ -22,21 +22,21 @@ From the `Dashboard`, go to `Mails` to land on the `Broadcasts` hub. Here you wi 2. Let's get acquainted with the interface. In the following image, we have demarcated all the sections. To see the description of a section, notice its number in the screenshot and find its description below. - - 1. **User Filters**: To select the users. - - 2. **Total Selected Users**: The total number of selected users as per the applied filters. - - 3. **Subject**: The email subject goes here. - - 4. **Variables**: [Liquid](https://liquidjs.com/) templating variables that are available for you to use in your email body. - - 5. **Email Compose Window**: Email content goes here. - - 6. **Email Preview**: Live email preview. - > During the preview, the Liquid variables will be displayed as placeholders. The actual values will be replaced when sending the actual mail. - - 7. **Send Button**: Sends the email immediately. - - 8. **Schedule Button**: Lets you schedule an email for later. + - 1. **User Filters**: To select the users. + - 2. **Total Selected Users**: The total number of selected users as per the applied filters. + - 3. **Subject**: The email subject goes here. + - 4. **Variables**: [Liquid](https://liquidjs.com/) templating variables that are available for you to use in your email body. + - 5. **Email Compose Window**: Email content goes here. + - 6. **Email Preview**: Live email preview. + > During the preview, the Liquid variables will be displayed as placeholders. The actual values will be replaced when sending the actual mail. + - 7. **Send Button**: Sends the email immediately. + - 8. **Schedule Button**: Lets you schedule an email for later. ![Broadcast Compose](/assets/emails/compose-broadcast.jpeg) 3. Compose your email. -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 `Mails` breadcrumb (located at the top of the page). +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 `Mails` breadcrumb (located at the top of the page). > Your changes are saved in real time, so you won't lose anything. You can always come back to your draft emails. @@ -64,4 +64,4 @@ Let's see how to send automated email campaigns (aka sequences) when something h ## Stuck Somewhere? -We are always here for you. Come chat with us in our Discord channel or send a tweet to @CourseLit. \ No newline at end of file +We are always here for you. Come chat with us in our Discord channel or send a tweet to @CourseLit. diff --git a/apps/docs/src/pages/en/email-marketing/introduction.md b/apps/docs/src/pages/en/email-marketing/introduction.md index d189354a0..d097e6351 100644 --- a/apps/docs/src/pages/en/email-marketing/introduction.md +++ b/apps/docs/src/pages/en/email-marketing/introduction.md @@ -1,6 +1,6 @@ --- -title: Email marketing and automation -description: Send broadcasts and email sequences using CourseLit +title: Email marketing and automation +description: Send broadcasts and email sequences using CourseLit layout: ../../../layouts/MainLayout.astro --- @@ -9,12 +9,15 @@ Sending timely emails to your audience keeps them engaged, which is why CourseLi > The feature is currently in beta, which means you may encounter bugs. Please report them in our Discord group if you run into any. ## Mailing Capabilities + CourseLit offers two types of mails. #### 1. [Broadcasts](/en/email-marketing/broadcast-mails) + Send one-off emails to selected recipients for quick updates or newsletters. #### 2. [Sequences](/en/email-marketing/sequences) + Automatically send a series of emails triggered by specific events in the system. ## Next step @@ -23,4 +26,4 @@ Learn [how to send broadcast emails](/en/email-marketing/broadcast-mails) to you ## Stuck somewhere? -We are always here for you. Come chat with us in our Discord channel or send a tweet at @CourseLit. \ No newline at end of file +We are always here for you. Come chat with us in our Discord channel or send a tweet at @CourseLit. diff --git a/apps/docs/src/pages/en/email-marketing/mail-access-request.md b/apps/docs/src/pages/en/email-marketing/mail-access-request.md index 35e2bc20a..ffae078b0 100644 --- a/apps/docs/src/pages/en/email-marketing/mail-access-request.md +++ b/apps/docs/src/pages/en/email-marketing/mail-access-request.md @@ -10,7 +10,7 @@ We do this to keep the service safe and healthy for everyone. > If you are self-hosting CourseLit, you do not have to go through this process. All the emailing features are unlocked for you. -## To request access +## To request access 1. From the `Dashboard`, go to `Mails` to see the following screen. @@ -18,7 +18,7 @@ We do this to keep the service safe and healthy for everyone. 2. The first step is to set your mailing address. This is required to comply with the [CAN-SPAM](https://www.ftc.gov/business-guidance/resources/can-spam-act-compliance-guide-business) act. -Click on the `Go to settings` button and you will be taken to a screen where you can enter your mailing address as shown below. Enter your mailing address and click save. +Click on the `Go to settings` button and you will be taken to a screen where you can enter your mailing address as shown below. Enter your mailing address and click save. ![Set mailing address](/assets/emails/set-mailing-address.png) @@ -36,4 +36,4 @@ Let's see [how to send broadcast emails](/en/email-marketing/broadcast-mails). ## Stuck somewhere? -We are always here for you. Come chat with us in our Discord channel or send a tweet to @CourseLit. \ No newline at end of file +We are always here for you. Come chat with us in our Discord channel or send a tweet to @CourseLit. diff --git a/apps/docs/src/pages/en/email-marketing/sequences.md b/apps/docs/src/pages/en/email-marketing/sequences.md index 5c0b581ec..afbfc070d 100644 --- a/apps/docs/src/pages/en/email-marketing/sequences.md +++ b/apps/docs/src/pages/en/email-marketing/sequences.md @@ -25,19 +25,19 @@ Here you will see all the sequences you have configured. 1. Click on the `New sequence` button on the right, in the `Sequences` hub. 2. Let's get acquainted with the interface. In the following image, we have demarcated all the sections. To see the description of a section, notice its number in the screenshot and find its description below. - - - 1. **Sequence Name**: Internal name of the sequence. - - 2. **From**: The sender's name that gets displayed in the emails sent. - - 3. **Entrance Condition**: The condition that triggers this sequence for a user. You can pick from the following conditions: + + - 1. **Sequence Name**: Internal name of the sequence. + - 2. **From**: The sender's name that gets displayed in the emails sent. + - 3. **Entrance Condition**: The condition that triggers this sequence for a user. You can pick from the following conditions: - `Tag added` - `Tag removed` - `Product purchased` - `Subscriber added` - - 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. - - 5. **Save**: A button to save your changes to the sequence. - - 6. **Start/Pause**: A button to start or pause the sequence. Once paused, the sequence won't be triggered for subsequent triggers occurring in the system. - - 7. **Email Row**: Shows an overview of one of the emails in the sequence. - - 8. **New Email Button**: A button to add a new email to the sequence. + - 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. + - 5. **Save**: A button to save your changes to the sequence. + - 6. **Start/Pause**: A button to start or pause the sequence. Once paused, the sequence won't be triggered for subsequent triggers occurring in the system. + - 7. **Email Row**: Shows an overview of one of the emails in the sequence. + - 8. **New Email Button**: A button to add a new email to the sequence. ![Sequence Compose](/assets/emails/compose-sequence.png) @@ -46,30 +46,32 @@ Here you will see all the sequences you have configured. 4. Let's start adding mails to this sequence. When you create a new sequence, an empty email is added to it by default. 5. Let's understand what information an email row shows: - - 1. **Delay Since the Last Sent Email**: This shows the time to wait (in days) since the last email before dispatching this email. - - 2. **Subject**: The subject of the email. - - 3. **Context Menu**: Houses options like `Delete`, etc. + + - 1. **Delay Since the Last Sent Email**: This shows the time to wait (in days) since the last email before dispatching this email. + - 2. **Subject**: The subject of the email. + - 3. **Context Menu**: Houses options like `Delete`, etc. > The default email has `0 days` as the delay, which signifies that the email should wait for 0 days since the last sent email. Since this is the first email in the sequence, it will be sent right away as soon as a user enters the sequence. 6. To edit the body of an email, click on the subject. This will open the email compose screen as shown below. 7. Let's get acquainted with the email compose interface: - - 1. **Delay**: The delay (in days) between this email and the previous one. - - 2. **Subject**: The email's subject. - - 3. **Preview Text**: The preview text that gets displayed in email inboxes. - - 4. **Status**: Only `Published` emails are sent to the users. If you want to skip any email without deleting it from the sequence, just switch its status to `Unpublished`. - - 5. **Variables**: [Liquid](https://liquidjs.com/) templating variables that are available for you to use in your email body. - - 6. **Email Compose Window**: Email content goes here. - - 7. **Email Preview**: Live email preview. - > During the preview, the Liquid variables will be displayed as placeholders. The actual values will be replaced when sending the actual mail. - - 8. **Save Button**: A button to save changes to the email. + + - 1. **Delay**: The delay (in days) between this email and the previous one. + - 2. **Subject**: The email's subject. + - 3. **Preview Text**: The preview text that gets displayed in email inboxes. + - 4. **Status**: Only `Published` emails are sent to the users. If you want to skip any email without deleting it from the sequence, just switch its status to `Unpublished`. + - 5. **Variables**: [Liquid](https://liquidjs.com/) templating variables that are available for you to use in your email body. + - 6. **Email Compose Window**: Email content goes here. + - 7. **Email Preview**: Live email preview. + > During the preview, the Liquid variables will be displayed as placeholders. The actual values will be replaced when sending the actual mail. + - 8. **Save Button**: A button to save changes to the email. ![Sequence's Email Compose](/assets/emails/compose-sequence-email.png) -8. Compose the email and hit `Save`. +8. Compose the email and hit `Save`. 9. To go back to the sequence settings, click on the `Compose sequence` breadcrumb as shown below. - + ![Go Back to Sequence Settings](/assets/emails/back-to-sequence-breadcrumb.jpeg) 10. Add more emails to the sequence by clicking on the `New email` button. @@ -81,4 +83,4 @@ Let's see how you can create and edit your website's pages. [Click here](/en/pag ## Stuck Somewhere? -We are always here for you. Come chat with us in our Discord channel or send a tweet to @CourseLit. \ No newline at end of file +We are always here for you. Come chat with us in our Discord channel or send a tweet to @CourseLit. diff --git a/apps/docs/src/pages/en/products/section.md b/apps/docs/src/pages/en/products/section.md index dcbf229f5..1f6895f5d 100644 --- a/apps/docs/src/pages/en/products/section.md +++ b/apps/docs/src/pages/en/products/section.md @@ -7,6 +7,7 @@ layout: ../../../layouts/MainLayout.astro A section is a logical grouping of lessons. It helps keep lessons structured and allows for the release of content in phases (called `Drip content`). ## Look and Feel + Here’s how it looks on various parts of the platform. ### Sections in Product Viewer @@ -23,7 +24,7 @@ Here’s how it looks on various parts of the platform. ## Add Section -1. To add a new section, click on the `New section` button on the `Product > Content` screen. +1. To add a new section, click on the `New section` button on the `Product > Content` screen. ![Add Section](/assets/products/add-section.jpeg) @@ -49,7 +50,7 @@ Here’s how it looks on various parts of the platform. You can release a section on a **specific date** or **after a certain number of days have elapsed since the time a student enrolls**. -If drip configuration is enabled for a section, a student won't be able to access it until it has been "dripped" to them. +If drip configuration is enabled for a section, a student won't be able to access it until it has been "dripped" to them. ### Drip by Date @@ -60,7 +61,7 @@ If drip configuration is enabled for a section, a student won't be able to acces 2. Select the date on which this section will be dripped. 3. Click `Continue` to save it. -### Drip After a Certain Number of Days Since Enrollment +### Drip After a Certain Number of Days Since Enrollment 1. If you want a section to be available to users after a certain number of days have elapsed since their enrollment in the course, this is the option you should opt for. diff --git a/apps/docs/src/pages/en/self-hosting/self-host.md b/apps/docs/src/pages/en/self-hosting/self-host.md index 6b07d21a1..283b89afb 100644 --- a/apps/docs/src/pages/en/self-hosting/self-host.md +++ b/apps/docs/src/pages/en/self-hosting/self-host.md @@ -11,7 +11,6 @@ We offer two ways to self-host CourseLit, which are as follows. 1. On [Vercel](https://vercel.com). 2. On a VPS using Docker. - ## Hosting on Vercel To quickly spin up an instance of CourseLit on Vercel, click the following button. diff --git a/apps/docs/src/styles/index.css b/apps/docs/src/styles/index.css index 1b18160b4..b6c95a82e 100644 --- a/apps/docs/src/styles/index.css +++ b/apps/docs/src/styles/index.css @@ -417,4 +417,4 @@ h2.heading { border-radius: 4px; font-size: small; color: white; -} \ No newline at end of file +}