Skip to content

Commit 29610f9

Browse files
committed
fix: add suggestions
1 parent c8b8a7c commit 29610f9

File tree

2 files changed

+26
-25
lines changed

2 files changed

+26
-25
lines changed

content/docs/platform/workflow/build-a-workflow.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ icon: 'Wrench'
1717
- Description of the workflow (optional)
1818
- Enable [translations](/platform/workflow/translations) (optional)
1919

20-
Once you've filled in the required fields, click on **Create Workflow**.
20+
Once you've filled in the required fields, click **Create Workflow**.
2121

2222
</Step>
2323
<Step title="Add a workflow step">

content/docs/platform/workflow/translations.mdx

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,54 +9,55 @@ icon: 'Languages'
99
Novu supports multi-language translations for workflows, allowing your notifications to dynamically adapt to your users' preferred language. This documentation covers everything you need to know to enable, configure, and manage translations for your workflows.
1010

1111
<Callout type="info">
12-
Translations feature is currently in `beta` and is available for `Team` and `Enterprise` plans.
12+
The translations feature is currently in `beta` and is available for `Team` and `Enterprise` plans.
1313
</Callout>
1414

15-
## Introduction
16-
17-
Workflow translation allows each notification workflow (e.g., onboarding, password reset, OTP, etc.) to support multiple locales. When a subscriber (user) receives a notification, Novu selects the appropriate translation based on the subscriber’s locale.
15+
Workflow translations allow each notification workflow, such as onboarding, password reset, and one time password (OTP), to support multiple locales. When a subscriber receives a notification, Novu selects the appropriate translation based on the subscriber's locale.
1816

1917
This feature helps teams:
2018

2119
- Reach users in their native language.
2220
- Customize language per workflow or layout.
2321
- Reduce friction in communication across geographies.
2422

25-
Translations can be managed on the [translation page](https://dashboard.novu.co/translations) on Novu dashboard. Select the default language and add the target languages you wish to support.
23+
You can manage translations on the[translation page](https://dashboard.novu.co/translations) on Novu dashboard. Select the default language and add the target languages that you wish to support.
2624

2725
![Translation page](/images/platform/workflow/translations/translations-page.png)
2826

2927
## Enabling translations
3028

31-
1. **While creating a new workflow**
29+
To use translations for a workflow, you need to enable them on the workflow level.
30+
31+
### While creating a new workflow
3232

33-
- Check the **Enable Translations** toggle.
34-
- Set the default locale (e.g., `en_US`).
35-
- Add target locales you wish to support (e.g., `fr_FR`, `es_ES`, `ja_JP`, etc.).
33+
- Turn on the **Enable Translations** toggle
34+
- Set the default locale, such as `en_US` or `en_GB`
35+
- Add the target locales you wish to support, such as `fr_FR`, `es_ES`, `ja_JP`
3636

37-
2. **While editing an existing workflow**
37+
### While editing an existing workflow
3838

39-
- Open an existing workflow.
40-
- Click the **Enable Translations** option in the right panel
41-
- Enable the toggle if not already enabled.
39+
- Open an existing workflow
40+
- Turn on the **Enable Translations** toggle
41+
- You don't need to take any action if the toggle is already on
4242

43-
Default and targeted locales can be configured on the translation page.
43+
You can configure the default and targeted locales on the [translation page](https://dashboard.novu.co/translations).
4444

4545
![Translation locale](/images/platform/workflow/translations/translations-default-and-target-locale.gif)
4646

47-
## Translation Groups
47+
## Translation groups
4848
A translation group contains all language variants for a workflow identified by a unique workflow ID.
4949

5050
You can:
5151

52-
- Search for groups on the **Translations** page.
53-
- View status per locale ('Outdated' or 'Up to date').
54-
- Import or export translations for a specific locale (e.g., `en_US`).
55-
- Import or export translations for all workflows where translations are enabled.
52+
- Search for groups on the translations page
53+
- View status per locale ('Outdated' or 'Up to date')
54+
- Import or export translations for a specific locale, such as `en_US
55+
- Import or export translations for all workflows where translations are enabled
5656
5757
## Translation JSON format
5858
59-
Each locale supports JSON-based translation files. For example, `en_US.json` file contains the default translations for the workflow. Translation JSON files can be updated using the JSON editor on the translation page.
59+
Each locale supports JSON-based translation files. For example, the `en_US.json` file contains the default translations for the workflow. You can update the translation JSON files using the JSON editor on the translation page.
60+
6061
```json
6162
{
6263
"in-app": {
@@ -70,19 +71,19 @@ Each locale supports JSON-based translation files. For example, `en_US.json` fil
7071
}
7172
```
7273
73-
You can export and re-upload these JSON files when translation updates are needed or use the JSON editor on the translation page to update the translations.
74+
You can update translations by editing the JSON files in the editor on the translations page or by exporting and re-uploading them.
7475
7576
![Translation JSON format](/images/platform/workflow/translations/translations_locale_content_edit.gif)
7677
77-
### Exporting and importing translations
78+
## Exporting and importing translations
7879
79-
#### Export
80+
### Export
8081
8182
- Navigate to the Translations section.
8283
- Click **Export en_US.json** to download the latest default file.
8384
- Use this as a base for other translations.
8485
85-
#### Import
86+
### Import
8687
8788
- Click **Import locale(s)**.
8889
- Upload JSON files (e.g., fr_FR.json, es_ES.json).

0 commit comments

Comments
 (0)