Update content to make it clear that Novu doesn't support lang only f…#1035
Update content to make it clear that Novu doesn't support lang only f…#1035jainpawan21 merged 1 commit intomainfrom
Conversation
…ormat. Add images to export and import section too
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughUpdates the translations documentation to clarify locale code format requirements (language_REGION format only), adds warning and info callouts, restructures export/import sections with enumerated step-by-step instructions and imagery references, and specifies that subscriber locales must be mapped to supported formats before sending to Novu. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In @content/docs/platform/workflow/translations.mdx:
- Around line 98-100: The sentence "Translation changes in default locale such
as `en_US` will mark other locales as *Outdated, needs update*" is missing a
terminal period; update that sentence in translations.mdx (near the Callout
text) to end with a period so it reads "...will mark other locales as *Outdated,
needs update*.".
- Around line 90-96: Update the image path in the "How to import translations"
section to match the export section (use
/images/platform/workflow/translations/import-translations.png) and rewrite step
3 to split the two actions into two sentences: first instruct the user to click
the locale (e.g., `en_US`), then instruct them to click the **Import
translation(s)** button to upload the translation JSON file.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
public/images/workflows/translations/export-translations.pngis excluded by!**/*.pngpublic/images/workflows/translations/import-translations.pngis excluded by!**/*.png
📒 Files selected for processing (1)
content/docs/platform/workflow/translations.mdx
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/workflow/translations.mdx
[style] ~86-~86: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...tton. 3. Select the workflow locale you want to export. 4. Click the download icon to d...
(REP_WANT_TO_VB)
[style] ~93-~93: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ations page. 2. Select the workflow you want to import translations into. - To impo...
(REP_WANT_TO_VB)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - docs-novu
- GitHub Check: Header rules - docs-novu
- GitHub Check: Pages changed - docs-novu
- GitHub Check: Build and Lint
🔇 Additional comments (3)
content/docs/platform/workflow/translations.mdx (3)
173-173: LGTM!Good addition that reinforces the
language_REGIONformat requirement from the warning callout, ensuring users see this important constraint in the best practices section.
15-16: No action needed.The
type="warn"attribute is the correct convention used consistently throughout the codebase, as evidenced by multiple instances across translations.mdx, manage-contexts.mdx, build-a-workflow.mdx, and several SDK documentation files. Thetype="info"andtype="warn"pattern matches the established style in this repository.Likely an incorrect or invalid review comment.
81-88: No action needed. The image path at line 88 is correct and points to an existing file at/images/workflows/translations/export-translations.png. While the file does use two different path conventions (/images/platform/workflow/translations/and/images/workflows/translations/), all image references—including line 88—correctly point to their respective existing files. The suggested fix in the original comment would break the image link.
| ### How to import translations | ||
|
|
||
| 1. Navigate to the translations page. | ||
| 2. Select the workflow you want to import translations into. | ||
| - To import locale into all workflows with translations enabled, click the **Import** button. | ||
| 3. Click on the locale, such as `en_US`, now click on the **Import translation(s)** button to upload the translation JSON file. | ||
|  |
There was a problem hiding this comment.
Fix image path and improve step clarity.
- Same image path inconsistency as the export section - should likely be
/images/platform/workflow/translations/... - Step 3 is a run-on sentence with two actions. Consider splitting for clarity.
Suggested fix
-3. Click on the locale, such as `en_US`, now click on the **Import translation(s)** button to upload the translation JSON file.
- 
+3. Click on the locale you want to update, such as `en_US`.
+4. Click the **Import translation(s)** button to upload the translation JSON file.
+ 📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### How to import translations | |
| 1. Navigate to the translations page. | |
| 2. Select the workflow you want to import translations into. | |
| - To import locale into all workflows with translations enabled, click the **Import** button. | |
| 3. Click on the locale, such as `en_US`, now click on the **Import translation(s)** button to upload the translation JSON file. | |
|  | |
| ### How to import translations | |
| 1. Navigate to the translations page. | |
| 2. Select the workflow you want to import translations into. | |
| - To import locale into all workflows with translations enabled, click the **Import** button. | |
| 3. Click on the locale you want to update, such as `en_US`. | |
| 4. Click the **Import translation(s)** button to upload the translation JSON file. | |
|  |
🧰 Tools
🪛 LanguageTool
[style] ~93-~93: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ations page. 2. Select the workflow you want to import translations into. - To impo...
(REP_WANT_TO_VB)
🤖 Prompt for AI Agents
In @content/docs/platform/workflow/translations.mdx around lines 90 - 96, Update
the image path in the "How to import translations" section to match the export
section (use /images/platform/workflow/translations/import-translations.png) and
rewrite step 3 to split the two actions into two sentences: first instruct the
user to click the locale (e.g., `en_US`), then instruct them to click the
**Import translation(s)** button to upload the translation JSON file.
| <Callout type="info">Translation files must be named using the `language_REGION.json` format, for example, `en_US.json`, `fr_FR.json`. Novu detects the locale automatically using the file name.</Callout> | ||
|
|
||
| 💡 Translation changes in default locale such as `en_US` will mark other locales as *Outdated, needs update* | ||
| Translation changes in default locale such as `en_US` will mark other locales as *Outdated, needs update* |
There was a problem hiding this comment.
Add missing punctuation.
Line 100 is missing a period at the end of the sentence.
Suggested fix
-Translation changes in default locale such as `en_US` will mark other locales as *Outdated, needs update*
+Translation changes in the default locale such as `en_US` will mark other locales as *Outdated, needs update*.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <Callout type="info">Translation files must be named using the `language_REGION.json` format, for example, `en_US.json`, `fr_FR.json`. Novu detects the locale automatically using the file name.</Callout> | |
| 💡 Translation changes in default locale such as `en_US` will mark other locales as *Outdated, needs update* | |
| Translation changes in default locale such as `en_US` will mark other locales as *Outdated, needs update* | |
| <Callout type="info">Translation files must be named using the `language_REGION.json` format, for example, `en_US.json`, `fr_FR.json`. Novu detects the locale automatically using the file name.</Callout> | |
| Translation changes in the default locale such as `en_US` will mark other locales as *Outdated, needs update*. |
🤖 Prompt for AI Agents
In @content/docs/platform/workflow/translations.mdx around lines 98 - 100, The
sentence "Translation changes in default locale such as `en_US` will mark other
locales as *Outdated, needs update*" is missing a terminal period; update that
sentence in translations.mdx (near the Callout text) to end with a period so it
reads "...will mark other locales as *Outdated, needs update*.".
2 participants
…ormat. Add images to export and import section too
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.