feat: add translation feature documentation #910
Conversation
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughA new documentation page detailing workflow translations has been added and integrated into the documentation navigation. The workflow creation guide was updated to reference the new translation feature, including instructions on enabling translations and linking to the dedicated documentation page. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant WorkflowFeature
User->>Docs: Reads "Build a Workflow" guide
Docs-->>User: Shows "Enable translations" option
User->>Docs: Follows link to "Translations" documentation
Docs-->>User: Explains translation setup and management
User->>WorkflowFeature: Configures translations as per documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
⏰ 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)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
content/docs/platform/workflow/translations.mdx (4)
33-36: Use the correct ISO code for Japanese locale
jp_JPis not a valid BCP 47/ISO locale. The correct code isja_JP.- - Add target locales you wish to support (e.g., `fr_FR`, `es_ES`, `jp_JP`, etc.). + - Add target locales you wish to support (e.g., `fr_FR`, `es_ES`, `ja_JP`, etc.).
59-60: Capitalize “JSON” for consistency- Translation json files can be updated using JSON editor on the translation page. + Translation JSON files can be updated using the JSON editor on the translation page.
96-99: Grammar & clarity in translation-key explanation-In Email or In-App editors, use `{{t.key}}` to insert a translatable string. if key is already added in the locale, it will be in the suggestions list. +In Email or In-App editors, use `{{t.key}}` to insert a translatable string. If the key already exists for the locale, it appears in the suggestions list.
125-126: Typo: “react out” → “reach out”-This feature is currently in work in progress. If you are looking to use translation in email layouts, react out to us at [email protected] +This feature is currently a work in progress. If you need translation support in email layouts, reach out to us at [email protected]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
public/images/platform/workflow/translations/translations-default-and-target-locale.gifis excluded by!**/*.gifpublic/images/platform/workflow/translations/translations-page.pngis excluded by!**/*.pngpublic/images/platform/workflow/translations/translations_locale_content_edit.gifis excluded by!**/*.gifpublic/images/platform/workflow/translations/translations_variable_use_in_step_editor.gifis excluded by!**/*.gif
📒 Files selected for processing (3)
content/docs/platform/meta.json(1 hunks)content/docs/platform/workflow/build-a-workflow.mdx(1 hunks)content/docs/platform/workflow/translations.mdx(1 hunks)
⏰ 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 (2)
content/docs/platform/workflow/build-a-workflow.mdx (1)
18-18: Addition looks correct – no action neededThe new “Enable translations” bullet is clearly phrased, correctly indented, and the relative link resolves to the new documentation page.
content/docs/platform/meta.json (1)
24-27: Navigation entry inserted in the right place
workflow/translationsis positioned logically between “build-a-workflow” and “template-editor”, matching the docs flow.
There was a problem hiding this comment.
I did not complete the review. @Aviatorscode2, review the self editing checklist and edit this topic, then re-request a review.
Inconsistent headings, missing periods, passive voice, and use of e.g. and etc. are all items on the checklist that you should fix before requesting an edit from me.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
content/docs/platform/workflow/translations.mdx (2)
7-7: Remove stacked H2 heading “Workflow translations”The page title in the front-matter already renders as an H1; leaving this H2 directly below creates a stacked-heading anti-pattern.
[past review comment → same concern]
31-41: Use ordered steps instead of bullets for workflow-creation actionsTurning on a toggle, setting a default locale, then adding target locales is a sequence. Numbered steps improve clarity and match Google style.
🧹 Nitpick comments (5)
content/docs/platform/workflow/translations.mdx (5)
23-23: Fix link formatting & wordingMissing space before the link and “Novu dashboard” should be preceded by “the”.
-You can manage translations on the[translation page](https://dashboard.novu.co/translations) on Novu dashboard. +You can manage translations on the [translation page](https://dashboard.novu.co/translations) in the Novu dashboard.
80-80: Eliminate redundant phrase “outside of”Google style recommends simply “outside”.
-...translations in a JSON file outside of the Novu dashboard... +...translations in a JSON file outside the Novu dashboard...
95-95: Tweak emphasis formatting
*Outdated, needs update*mixes italics with comma; consider:-*Outdated, needs update* +*Outdated – needs update*
99-99: Grammar: possessive form of “default locale”-...contains the default locale' translations keys... +...contains the default locale’s translation keys...
117-129: Mention support for nested translation keysCustomers can use keys like
{{t.title.button.submit}}; adding a brief note here prevents confusion.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
public/images/platform/workflow/translations/translations_master_json_file.pngis excluded by!**/*.png
📒 Files selected for processing (1)
content/docs/platform/workflow/translations.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/workflow/translations.mdx
[style] ~80-~80: This phrase is redundant. Consider using “outside”.
Context: ...eate/update translations in a JSON file outside of the Novu dashboard, you can do so by ex...
(OUTSIDE_OF)
⏰ 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
There was a problem hiding this comment.
The structure/developer journey of the page is broken. I went through the feature step by step and this is the structure the content was supposed to take:
- Set up translations
- Enable translation in a workflow
- Using transition in In-app and Email step editor
- Translation JSON
- Import translations
- Manage translations
- Configure translations settings
- Import
- Export
- Delete and disable translations
Not sure we can fix this today since the docs needs to be live, but I am happy to hear suggestions @DianaHackmamba @jainpawan21
Summary by CodeRabbit
New Features
Documentation