Merged
Conversation
* Create content for the overview page * Update content/docs/platform/workflow/overview.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/overview.mdx * Move the feature section to the top --------- Co-authored-by: DianaHackmamba <diana@hackmamba.io> Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>
* Content for the Trigger workflow * remove parentheses
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughReorganizes workflow documentation: removes legacy workflow pages, adds new workflow pages and step configuration docs, updates multiple internal links, adds redirect mappings, and updates navigation metadata to the new workflow documentation structure. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 1 | ❌ 3❌ Failed checks (2 warnings, 1 inconclusive)
✅ Passed checks (1 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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 |
#1042) * Create content for create a workflow page. Also deleted some unused images * Update the content for the page * Update content/docs/platform/workflow/create-a-workflow.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/create-a-workflow.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/create-a-workflow.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/create-a-workflow.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * fix: add dot in the slug format * Fix error and add redirects from build-a-workflow to create-a-workflow * Create content for the overview page (#1041) * Create content for the overview page * Update content/docs/platform/workflow/overview.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/overview.mdx * Move the feature section to the top --------- Co-authored-by: DianaHackmamba <diana@hackmamba.io> Co-authored-by: Pawan Jain <jainpawan211199@gmail.com> * Content for the Trigger workflow (#1046) * Content for the Trigger workflow * remove parentheses --------- Co-authored-by: DianaHackmamba <diana@hackmamba.io> Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>
* Content for configure worklow page * Update the content for the configure workflow page * Implement feedback and add redirects for Tags and Payload schema * fix: update configure workflow page --------- Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>
* Content for the Add and configure steps section. * Add more content to the section * Update content for the index page and add redirects * fix images * fix: wordings and add todo --------- Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>
* Content for the add notification content page * Add missing gifs * Update titles and icon in personalize-content.mdx * Enhance description for Personalize Content section Updated the description to provide details on personalizing notification content using template variables and LiquidJS filters. * Implement feedback * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/personalize-content.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content and add redirect * fix: content and images --------- Co-authored-by: DianaHackmamba <diana@hackmamba.io> Co-authored-by: Pawan Jain <jainpawan211199@gmail.com>
* Content for the monitor and debug workflow * Update page based on feedback from Diana
* Clean up the build a workflow section * Add link to digest data
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
Note
Due to the large number of review comments, Critical, Major severity comments were prioritized as inline comments.
🤖 Fix all issues with AI agents
In
`@content/docs/platform/workflow/add-and-configure-steps/action-steps/digest.mdx`:
- Around line 81-94: There are contradictory statements about scheduled digest
behavior: the paragraph under the digest window says "If no events occur during
a scheduled window, no notification is sent" but the FAQ Accordion titled "If
scheduled digest is set for 9:00 AM daily then will the digest be sent..." says
the digest will be sent regardless; confirm the actual product behavior and make
the docs consistent by updating either the main paragraph (near the "Extend to
subscriber’s schedule" section) or the FAQ Accordion content to reflect the true
behavior, and add a short clarifying line about whether empty digests are
suppressed or delivered and how "Extend to subscriber’s schedule" affects
delivery timing.
In `@content/docs/platform/workflow/create-a-workflow.mdx`:
- Line 85: Update the Callout link target so it points to the correct page:
replace the href `/platform/workflow/monitor-and-debug` inside the Callout
element with `/platform/workflow/monitor-and-debug-workflow`; ensure the Callout
text remains unchanged and the link points to the existing
`monitor-and-debug-workflow` document.
In `@content/docs/platform/workflow/trigger-workflow.mdx`:
- Around line 42-54: The cURL example for POST
'https://api.novu.co/v1/events/trigger' is missing shell line-continuation
backslashes, so copy-pasting will fail; update the code block that begins with
"curl -X POST 'https://api.novu.co/v1/events/trigger'" and add a trailing
backslash "\" to the end of each line except the final JSON payload line (e.g.,
after the URL, each -H header line and the -d flag) so the multi-line command
executes correctly while keeping the same headers ("Content-Type", "Accept",
"Authorization: ApiKey <NOVU_SECRET_KEY>") and JSON body ("name", "to" with
"subscriberId").
- Line 105: Update the incorrect context docs link in the Callout within the
trigger-workflow.mdx content: change the href that currently points to
"/platform/workflow/contexts/contexts-in-workflows" to include the missing
segment so it reads
"/platform/workflow/advanced-features/contexts/contexts-in-workflows.mdx" (or
the site-relative path with "advanced-features"), ensuring the Callout link to
the Context documentation is corrected; locate the Callout containing the link
text "Context documentation" in the file and replace the path accordingly.
In `@src/middleware.ts`:
- Around line 89-90: The redirects map contains unreachable keys with URL
fragments (e.g., '/platform/workflow/build-a-workflow#manage-payload-schema' and
the similar inbox fragment entry) because request.nextUrl.pathname never
includes '#' fragments; remove those fragment-containing entries from the
middleware redirects map (leave/adjust plain-path entries like
'/platform/workflow/build-a-workflow' as needed) and, if anchor-targeting is
required, implement client-side handling on the destination page (add a small
client-side script to read location.hash and scroll/redirect to
'#manage-payload-schema' or '#inbox' after the server-side redirect to
'/platform/workflow/configure-workflow').
🟡 Minor comments (31)
content/docs/platform/integrations/sms/index.mdx-27-27 (1)
27-27:⚠️ Potential issue | 🟡 MinorLink update is correct, but the surrounding section has email/SMS terminology mix-ups.
The link change to
/platform/workflow/create-a-workflowis accurate. However, this section contains pre-existing copy-paste issues from the email integration page — for example, Line 25 heading says "Add the email channel to your workflow" in what is the SMS docs, Line 32 says "Within the Email step editor", and Line 17 says "Add an email provider". Consider fixing these while you're updating this file.content/docs/platform/workflow/add-and-configure-steps/step-conditions.mdx-80-80 (1)
80-80:⚠️ Potential issue | 🟡 MinorMinor grammar issue.
Missing "to" before "configure step conditions".
Proposed fix
-You can use data from the [payload schema](/platform/workflow/configure-workflow#payload-schema) or custom payload data passed during the workflow trigger call to the Novu API configure step conditions. This allows you to define dynamic rules based on the data unique to each workflow execution. +You can use data from the [payload schema](/platform/workflow/configure-workflow#payload-schema) or custom payload data passed during the workflow trigger call to the Novu API to configure step conditions. This allows you to define dynamic rules based on the data unique to each workflow execution.content/docs/platform/workflow/trigger-workflow.mdx-16-18 (1)
16-18:⚠️ Potential issue | 🟡 MinorDuplicate paragraph.
Lines 16 and 18 convey the same information with slightly different wording. Remove one to avoid redundancy.
Proposed fix — keep the more detailed version
-Workflows in Novu are triggered by sending an event through the Event API. An event represents an action or occurrence in your system and is identified by the workflow's trigger identifier. - -Workflows in Novu are triggered by sending events to the Event API. An event represents a meaningful action in your system, for example, an order created or a comment added and is mapped to a workflow using the workflow's trigger identifier. +Workflows in Novu are triggered by sending events to the Event API. An event represents a meaningful action in your system — for example, an order created or a comment added — and is mapped to a workflow using the workflow's trigger identifier.content/docs/platform/inbox/configuration/preferences.mdx-63-63 (1)
63-63:⚠️ Potential issue | 🟡 MinorLink text doesn't match the new page title.
The link text says "Building Workflows guide" but now points to the "Create a Workflow" page. Consider updating the text to align with the new page name.
Proposed fix
-<Callout type ="info">Learn how to configure channel steps in a workflow in the [Building Workflows guide](/platform/workflow/create-a-workflow).</Callout> +<Callout type="info">Learn how to configure channel steps in a workflow in the [Create a Workflow guide](/platform/workflow/create-a-workflow).</Callout>content/docs/platform/workflow/trigger-workflow.mdx-221-231 (1)
221-231:⚠️ Potential issue | 🟡 MinorTrailing comma produces invalid JSON in the cURL body.
Line 230 has a trailing comma after the
"to"array (],), which is invalid JSON and will cause a parse error if copy-pasted.Proposed fix
] -}' +}'Specifically, remove the comma after the closing
]on line 229:- ], + ]content/docs/platform/workflow/add-and-configure-steps/step-conditions.mdx-125-125 (1)
125-125:⚠️ Potential issue | 🟡 MinorFix incorrect Context documentation link path.
Line 125 links to
/platform/workflow/contexts, but the contexts documentation is located at/platform/workflow/advanced-features/contexts. Update the link to point to the correct path.content/docs/platform/workflow/monitor-and-debug-workflow.mdx-50-50 (1)
50-50:⚠️ Potential issue | 🟡 MinorTypo: "detail" → "detailed"
-The Requests tab in the Activity Feed shows detail information about every request made to the Event API. +The Requests tab in the Activity Feed shows detailed information about every request made to the Event API.content/docs/platform/workflow/create-a-workflow.mdx-43-43 (1)
43-43:⚠️ Potential issue | 🟡 MinorTypo: "detials" → "details"
-Templates are pre-built workflows for common notification scenarios. They include pre-configured steps, sample content, and pre-filled workflow detials that you can customize. +Templates are pre-built workflows for common notification scenarios. They include pre-configured steps, sample content, and pre-filled workflow details that you can customize.content/docs/platform/workflow/configure-workflow.mdx-134-134 (1)
134-134:⚠️ Potential issue | 🟡 MinorTypo: "documetation" → "documentation"
-<Callout>To learn more about how notification content are added to the template editors, refer to the [Add notification content](/platform/workflow/add-notification-content) documetation</Callout> +<Callout>To learn more about how notification content is added to the template editors, refer to the [Add notification content](/platform/workflow/add-notification-content) documentation.</Callout>Also: "content are" → "content is" (content is uncountable), and missing period at end.
content/docs/platform/workflow/configure-workflow.mdx-122-122 (1)
122-122:⚠️ Potential issue | 🟡 MinorDouble period at end of sentence.
-If you already have a sample payload, you can import it as a JSON object from the **Manage workflow schema** section.. Novu automatically infers property names, types, and nested structures. +If you already have a sample payload, you can import it as a JSON object from the **Manage workflow schema** section. Novu automatically infers property names, types, and nested structures.content/docs/platform/workflow/configure-workflow.mdx-54-54 (1)
54-54:⚠️ Potential issue | 🟡 MinorTypo: "worflow" → "workflow"
-This is useful for high-priority notifications that are related to security, financial, or access-related information, where missing a message could have some consequences. +This is useful for high-priority notifications that are related to security, financial, or access-related information, where missing a message could have some consequences.Also on this line: "worflow" should be "workflow":
-Novu allows you to mark a workflow as critical, this means that the notification sent from that worflow must always be delivered +Novu allows you to mark a workflow as critical, this means that the notification sent from that workflow must always be deliveredcontent/docs/platform/workflow/create-a-workflow.mdx-27-37 (1)
27-37:⚠️ Potential issue | 🟡 MinorDuplicate step number: two items numbered "4."
Lines 27 and 35 both use step number
4., which will render incorrectly in the ordered list. Line 35 should be5.and line 37 should be6..-4. **Enable translations** (Optional): Support multiple locales for this workflow. This can be enabled after workflow creation in the workflow editor. +5. **Enable translations** (Optional): Support multiple locales for this workflow. This can be enabled after workflow creation in the workflow editor. <Callout>To learn more about translations, refer to [Translations](/platform/workflow/translations).</Callout> -5. Click **Create workflow**. +6. Click **Create workflow**.content/docs/platform/workflow/monitor-and-debug-workflow.mdx-18-20 (1)
18-20:⚠️ Potential issue | 🟡 MinorMultiple typos in this section.
- Line 18: "triggerred" → "triggered"
- Line 20: "gives you assess to" → "gives you access to"
-The Workflow Runs tab shows the details of every workflow triggerred to each subscriber. Each run represents a single execution instance and reflects how the workflow behaved for that subscriber. +The Workflow Runs tab shows the details of every workflow triggered for each subscriber. Each run represents a single execution instance and reflects how the workflow behaved for that subscriber. -You can filter workflow runs using parameters such as time period, workflow identifier, and channel. Selecting a workflow run opens the run details view, which gives you assess to execution outcomes of each step in the workflow and investigate delivery issues. +You can filter workflow runs using parameters such as time period, workflow identifier, and channel. Selecting a workflow run opens the run details view, which gives you access to execution outcomes of each step in the workflow and helps investigate delivery issues.content/docs/platform/workflow/overview.mdx-26-26 (1)
26-26:⚠️ Potential issue | 🟡 MinorTwo typos: "condtional" → "conditional", "worfklow" → "workflow"
-- **Step conditions**: Define condtional logic for each worfklow steps. +- **Step conditions**: Define conditional logic for each workflow step.Also: "steps" → "step" for grammatical agreement with "each".
content/docs/platform/workflow/overview.mdx-68-73 (1)
68-73:⚠️ Potential issue | 🟡 MinorFix broken link: change
/platform/workflow/trigger-workflowsto/platform/workflow/trigger-workflowThe actual file is
trigger-workflow.mdx(singular), but the link uses the plural form/platform/workflow/trigger-workflows, which will result in a 404.content/docs/platform/workflow/add-and-configure-steps/action-steps/digest.mdx-95-97 (1)
95-97:⚠️ Potential issue | 🟡 MinorInaccurate FAQ answer: Regular and Scheduled digest set to 1 hour are not the same.
A Regular digest with a 1-hour window is relative (starts from the first event), while a Scheduled digest set to "every hour" fires at fixed clock intervals regardless of when events arrive. The answer "Both digests are same in this case" is misleading and should clarify the difference in timing semantics.
content/docs/platform/workflow/add-and-configure-steps/action-steps/delay.mdx-14-14 (1)
14-14:⚠️ Potential issue | 🟡 MinorGrammar: "about the when to use" → "about when to use".
Same issue as in throttle.mdx.
-<Callout>To learn about the when to use Delay in a workflow, refer to the [Delay step overview](/platform/workflow/add-and-configure-steps#delay).</Callout> +<Callout>To learn about when to use Delay in a workflow, refer to the [Delay step overview](/platform/workflow/add-and-configure-steps#delay).</Callout>content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx-220-220 (1)
220-220:⚠️ Potential issue | 🟡 MinorBroken email link — missing
mailto:prefix.The link
[contact Support](support@novu.co)will not open a mail client; it will resolve as a relative URL.-If you need more than 100 layouts, please [contact Support](support@novu.co).</Callout> +If you need more than 100 layouts, please [contact Support](mailto:support@novu.co).</Callout>content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx-277-277 (1)
277-277:⚠️ Potential issue | 🟡 MinorMissing word: "If the layout used by" → "If the layout is used by".
-4. Click **Delete layout** and confirm. If the layout used by an email step, then you are notified on which step uses this layout. +4. Click **Delete layout** and confirm. If the layout is used by an email step, then you are notified on which step uses this layout.content/docs/platform/workflow/add-and-configure-steps/index.mdx-19-19 (1)
19-19:⚠️ Potential issue | 🟡 MinorGrammar fixes: missing article and extra space.
-<Callout>You can create custom step using Novu Framework . For more information, refer to the [Custom steps](/framework/custom) documentation.</Callout> +<Callout>You can create a custom step using Novu Framework. For more information, refer to the [Custom steps](/framework/custom) documentation.</Callout>content/docs/platform/workflow/add-and-configure-steps/action-steps/throttle.mdx-12-12 (1)
12-12:⚠️ Potential issue | 🟡 MinorGrammar: "about the when to use" → "about when to use".
-<Callout>To learn about the when to use Throttle in a workflow, refer to the [Throttle step overview](/platform/workflow/add-and-configure-steps#throttle).</Callout> +<Callout>To learn about when to use Throttle in a workflow, refer to the [Throttle step overview](/platform/workflow/add-and-configure-steps#throttle).</Callout>content/docs/platform/workflow/add-notification-content/personalize-content.mdx-154-154 (1)
154-154:⚠️ Potential issue | 🟡 MinorTypos: "us" → "is" and "tempate" → "template".
- This helper is built using `steps.digest-step.events` and the LiquidJS `toSentence` filter. When the `sentenceSummary` variable us used in the tempate editor, it inserts logic equivalent to: + This helper is built using `steps.digest-step.events` and the LiquidJS `toSentence` filter. When the `sentenceSummary` variable is used in the template editor, it inserts logic equivalent to:content/docs/platform/workflow/add-notification-content/personalize-content.mdx-100-100 (1)
100-100:⚠️ Potential issue | 🟡 MinorGrammar: "steps that runs" → "steps that run".
-Digest variables expose the data produced by a Digest step and are available to all channel steps that runs after that digest step. +Digest variables expose the data produced by a Digest step and are available to all channel steps that run after that digest step.content/docs/platform/workflow/add-and-configure-steps/action-steps/delay.mdx-66-68 (1)
66-68:⚠️ Potential issue | 🟡 MinorMissing commas around parenthetical clause.
-A dynamic delay also called a variable-based delay determines the delay duration using a variable from the event payload. +A dynamic delay, also called a variable-based delay, determines the delay duration using a variable from the event payload.content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx-93-93 (1)
93-93:⚠️ Potential issue | 🟡 MinorGrammar: "Body fields is" → "Body field is".
-The block editor is a `WYSIWYG` editor that allows you to create and edit email templates. It has two fields: subject and body. The Block editor Body fields is made of blocks. +The block editor is a `WYSIWYG` editor that allows you to create and edit email templates. It has two fields: subject and body. The Block editor Body field is made of blocks.content/docs/platform/workflow/add-notification-content/personalize-content.mdx-183-183 (1)
183-183:⚠️ Potential issue | 🟡 MinorTypos: "for more all suuported" and missing period.
-All Novu template editors support [LiquidJS](https://liquidjs.com/index.html), this allows you to add logic and control flow to your notification content. It enables conditional rendering, iteration, and value transformation directly inside channel template editors. Refer official [LiquidJS documentation](https://liquidjs.com/index.html) for more all suuported statements and helpers +All Novu template editors support [LiquidJS](https://liquidjs.com/index.html), this allows you to add logic and control flow to your notification content. It enables conditional rendering, iteration, and value transformation directly inside channel template editors. Refer to the official [LiquidJS documentation](https://liquidjs.com/index.html) for all supported statements and helpers.content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx-61-61 (1)
61-61:⚠️ Potential issue | 🟡 MinorStray hyphen in the navigation targets list.
The dash before
_unfencedTopappears to be a formatting artifact — it renders as a separate list bullet or dangling character rather than part of the list item.-- Navigation targets (`_self`, `_blank`, `_parent`, `_top`, and - `_unfencedTop`) +- Navigation targets (`_self`, `_blank`, `_parent`, `_top`, and `_unfencedTop`)content/docs/platform/workflow/add-notification-content/personalize-content.mdx-171-179 (1)
171-179:⚠️ Potential issue | 🟡 MinorMultiple text issues in the Context variables section.
Line 171 is garbled ("Contexts variables a from the context data"), and Line 179 has "tempate" again.
Suggested fix
-Contexts variables a from the context data. Once a context is created either through the Novu dashboard or API, its data becomes available in all channel templates editors and can be referenced using the context namespace. +Context variables come from context data. Once a context is created either through the Novu dashboard or API, its data becomes available in all channel template editors and can be referenced using the context namespace.-<Callout>To learn how to create and manage context data, and how to use the context data in the tempate editor, see the [Context documentation](/platform/workflow/contexts).</Callout> +<Callout>To learn how to create and manage context data, and how to use the context data in the template editor, see the [Context documentation](/platform/workflow/contexts).</Callout>content/docs/platform/workflow/add-and-configure-steps/index.mdx-72-76 (1)
72-76:⚠️ Potential issue | 🟡 MinorGrammar and consistency issues in the Delay use-case list.
Line 72: "This is useful use cases" → "This is useful for use cases". Lines 75–76 mix gerund ("Waiting") and imperative ("Wait", "Send") forms — pick one style for the list.
Suggested fix
-Delay is used when timing matters, whether you need to wait a fixed amount of time, resume execution at a scheduled moment, or defer execution based on data from the trigger payload. This is useful use cases such as: +Delay is used when timing matters, whether you need to wait a fixed amount of time, resume execution at a scheduled moment, or defer execution based on data from the trigger payload. This is useful for use cases such as: -- Waiting for X amount of time before sending the message -- Wait for a short period of time before sending a push message in case the user seen the notification in the Inbox Component -- Send a reminder email 24 hours after a user abandons their shopping cart to encourage checkout completion -- Send a follow-up message 3 days after user registration to check if they need onboarding assistance +- Waiting for X amount of time before sending the message +- Waiting for a short period before sending a push message in case the user has seen the notification in the Inbox component +- Sending a reminder email 24 hours after a user abandons their shopping cart to encourage checkout completion +- Sending a follow-up message 3 days after user registration to check if they need onboarding assistancecontent/docs/platform/workflow/add-and-configure-steps/action-steps/throttle.mdx-8-8 (1)
8-8:⚠️ Potential issue | 🟡 MinorTypos: capitalize "it" → lowercase, and stray "b" at end of sentence.
-After adding a Throttle step to a workflow, It limits the number of times a workflow is allowed to continue within a specified time window b. Once the execution limit is reached, the workflow stops at the Throttle step and downstream steps are skipped. +After adding a Throttle step to a workflow, it limits the number of times a workflow is allowed to continue within a specified time window. Once the execution limit is reached, the workflow stops at the Throttle step and downstream steps are skipped.content/docs/platform/workflow/add-and-configure-steps/action-steps/delay.mdx-48-53 (1)
48-53:⚠️ Potential issue | 🟡 MinorScheduled delay options list is unclear — missing articles and context.
The bare "until minute / until hour / until day" phrasing is confusing. Consider rephrasing for clarity:
Suggested fix
-You can configure scheduled delays to resume execution: - -- until minute. -- until hour at specific minutes. -- until day at specific hour and minutes. -- until week and days of the week at specific hours and minutes. -- until month on specific days of the month and weekdays at hours and minutes. +You can configure scheduled delays to resume execution at different granularities: + +- **Minute**: Resume at a specific minute. +- **Hour**: Resume at a specific hour and minute. +- **Day**: Resume at a specific time of day. +- **Week**: Resume on specific days of the week at a given time. +- **Month**: Resume on specific days of the month at a given time.
content/docs/platform/workflow/add-and-configure-steps/action-steps/digest.mdx
Outdated
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment.
Actionable comments posted: 14
🤖 Fix all issues with AI agents
In `@content/docs/platform/inbox/advanced-concepts/multi-tenancy.mdx`:
- Line 87: The documentation link inside the Callout (the string
"/platform/workflow/advanced-features/contexts/contexts-in-workflows.mdx")
includes a .mdx extension; remove the ".mdx" so the path becomes
"/platform/workflow/advanced-features/contexts/contexts-in-workflows" to match
other docs and ensure it resolves to the rendered page—update the Callout
content accordingly.
In
`@content/docs/platform/workflow/add-and-configure-steps/configure-action-steps/delay.mdx`:
- Around line 72-73: Update the ISO-8601 timestamp example so it is a future
date (the current example `2025-01-01T12:00:00Z` is past); change it to a later
date such as `2027-01-01T12:00:00Z` and ensure the same future date is used
consistently in the corresponding ISO example and the code block that currently
uses `2026-01-01` so both examples match and remain valid.
- Line 18: The sentence "Delay supports delivery aware execution:" should
hyphenate the compound adjective; update the text where the string "Delay
supports delivery aware execution:" appears (in the Delay section) to read
"Delay supports delivery-aware execution:" so the compound adjective is correct.
In
`@content/docs/platform/workflow/add-and-configure-steps/configure-action-steps/digest.mdx`:
- Line 37: The sentence "You can configure the digest duration in from the
**Digest events for** field:" contains an extraneous word "in"; update the copy
to remove "in" so it reads "You can configure the digest duration from the
**Digest events for** field:" (locate the line containing "You can configure the
digest duration in from the **Digest events for** field:" in digest.mdx and
change accordingly).
- Line 94: The sentence "Both digests are same in this case." is missing the
article "the"; change it to "Both digests are the same in this case." so the
copy in configure-action-steps/digest.mdx reads correctly.
In
`@content/docs/platform/workflow/add-and-configure-steps/configure-action-steps/meta.json`:
- Around line 2-3: The title and description fields in meta.json are using
inconsistent casing for "Steps"—the "title" value "Configure Action Steps"
capitalizes Steps while the "description" value "Configure Action steps" does
not; update either the "title" or the "description" so both use the same casing
(e.g., change "description" to "Configure Action Steps" or change "title" to
"Configure Action steps") to ensure consistency between the "title" and
"description" entries.
In
`@content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx`:
- Line 156: In the sentence inside the "repeat block" explanation, change the
compound modifier "item level" to the hyphenated form "item-level" so it reads
"item-level properties"; update the text where it currently says 'which allows
you to reference item level properties directly' to use "item-level" for correct
compound modifier styling.
- Line 55: Change the heading text "Actions buttons" to "Action buttons" in the
document (look for the Markdown heading line containing "### Actions buttons" in
channels-template-editors.mdx) so the singular form is used; update only that
heading text.
- Line 10: Update the sentence "The channel template editors is where you define
the content of the notification that is delivered to your subscribers when a
workflow runs." to use correct subject-verb agreement by replacing "is" with
"are" so it reads "The channel template editors are where you define the content
of the notification that is delivered to your subscribers when a workflow runs."
In
`@content/docs/platform/workflow/add-notification-content/personalize-content.mdx`:
- Line 156: Fix the typo in the explanatory sentence: change "us used" to "is
used" in the sentence that references the sentenceSummary variable and the
helpers built from steps.digest-step.events and the LiquidJS toSentence filter
(the line starting "This helper is built using `steps.digest-step.events`...").
Ensure the corrected text reads "When the `sentenceSummary` variable is used in
the template editor, it inserts logic equivalent to:".
In `@content/docs/platform/workflow/configure-workflow.mdx`:
- Around line 108-111: Fix the minor grammar in the "Define workflow schema"
section by replacing the incorrect phrase "channels steps" with "channel steps"
in the content under the "Define workflow schema" heading so the sentence reads
"...when configuring channel steps or digest actions."
In `@content/docs/platform/workflow/create-a-workflow.mdx`:
- Around line 64-69: The phrase "Add, or remove the workflow tags." in the file
content/docs/platform/workflow/create-a-workflow.mdx should remove the
unnecessary comma; change the text to "Add or remove the workflow tags."
ensuring the sentence now correctly joins the two actions without the comma
(locate the string "Add, or remove the workflow tags." to make the edit).
- Line 75: Replace the phrase "Find the workflow in Workflows page." with "Find
the workflow in the Workflows page." in the document; also make the identical
change for the second occurrence of that phrase elsewhere in the file (the later
instance that matches the same wording). Ensure both sentences now include the
article "the" before "Workflows page."
In `@content/docs/platform/workflow/monitor-and-debug-workflow.mdx`:
- Line 10: Update the sentence in the Monitor and Debug Workflow doc that
currently reads "From the Activity Feed, you can inspect each workflow runs and
API requests to see how each subscriber notification was processed." to use the
correct singular noun: change "each workflow runs" to "each workflow run" so the
sentence reads "From the Activity Feed, you can inspect each workflow run and
API requests to see how each subscriber notification was processed."
🧹 Nitpick comments (3)
content/docs/platform/workflow/add-and-configure-steps/configure-action-steps/delay.mdx (1)
109-115: FAQ formatting inconsistent withdigest.mdx.
digest.mdxuses<Accordions>/<Accordion>components for FAQs, but this page uses a plain###heading. Consider using the same Accordion pattern for visual consistency across the action-step docs.Suggested change
## FAQs -### If delay step fails, will the workflow continue to the next step? - No, workflow execution will stop immediately if the delay step fails due to an error. Common errors are: - - Invalid ISO date format. - - Invalid duration object format. - - Past datetime is specified. +<Accordions type="multiple"> + <Accordion title="If the delay step fails, will the workflow continue to the next step?"> + No, workflow execution will stop immediately if the delay step fails due to an error. Common errors are: + - Invalid ISO date format. + - Invalid duration object format. + - Past datetime is specified. + </Accordion> +</Accordions>content/docs/platform/workflow/overview.mdx (2)
12-12: Internal link opens in a new tab.The Callout links to
/platform/concepts/workflowswithtarget="_blank". Since this is an internal docs link, opening it in a new tab may be unexpected for users navigating within the same site. Consider using a standard Markdown link instead.Proposed fix
-<Callout type="info">If you're new to workflows, see the <a href="/platform/concepts/workflows" target="_blank" rel="noopener noreferrer">Workflows core concept page</a> for an in-depth overview of what workflows are and how they fit into Novu's notification system.</Callout> +<Callout type="info">If you're new to workflows, see the [Workflows core concept page](/platform/concepts/workflows) for an in-depth overview of what workflows are and how they fit into Novu's notification system.</Callout>
24-24: Nit: "Multi-channels" → "Multi-channel".When used as an adjective (modifying "support" implied by the colon), the standard form is "Multi-channel" (singular).
Proposed fix
-- **Multi-channels**: Email, in-app, SMS, push, and chat channels. +- **Multi-channel**: Email, in-app, SMS, push, and chat channels.
content/docs/platform/inbox/advanced-concepts/multi-tenancy.mdx
Outdated
Show resolved
Hide resolved
content/docs/platform/workflow/add-and-configure-steps/configure-action-steps/delay.mdx
Outdated
Show resolved
Hide resolved
content/docs/platform/workflow/add-and-configure-steps/configure-action-steps/delay.mdx
Outdated
Show resolved
Hide resolved
content/docs/platform/workflow/add-and-configure-steps/configure-action-steps/digest.mdx
Outdated
Show resolved
Hide resolved
content/docs/platform/workflow/add-and-configure-steps/configure-action-steps/digest.mdx
Outdated
Show resolved
Hide resolved
content/docs/platform/workflow/add-notification-content/personalize-content.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…re-action-steps/digest.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…re-action-steps/delay.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…re-action-steps/meta.json Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…alize-content.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…ls-template-editors.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…ls-template-editors.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Fix all issues with AI agents
In
`@content/docs/platform/workflow/add-and-configure-steps/configure-action-steps/delay.mdx`:
- Around line 82-86: The JSON example uses a past ISO date for the "delayTill"
field; change the value to a future date consistent with the guidance (e.g.,
update "delayTill" from "2026-01-01T12:00:00Z" to "2027-01-01T12:00:00Z") so the
example matches the text that requires a future date/time and the earlier
example on Line 72.
In
`@content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx`:
- Line 29: Fix the subject-verb agreement in the sentence "The template editor
lets you control what users see, how they act on it, and how it appears in your
application and consist of the following configurable fields:" by changing
"consist" to "consists" so the singular subject "template editor" matches the
verb; update the sentence in channels-template-editors.mdx wherever that exact
sentence appears.
- Line 19: Change the phrase "channel specific" to the hyphenated compound
"channel-specific" in the sentence starting "While some channel editors..." to
correctly hyphenate the compound modifier and ensure consistent style across the
document.
In
`@content/docs/platform/workflow/add-notification-content/personalize-content.mdx`:
- Line 32: Replace the ungrammatical phrase "every template variables" inside
the Callout element with a correct form; update the sentence in the Callout (the
text inside <Callout>...</Callout>) to read either "all template variables" or
"every template variable" so the noun and determiner agree (e.g., "You can
configure all template variables from the template editor to fit your use
case.").
- Line 186: Replace the comma splice in the sentence that begins "All Novu
template editors support LiquidJS, this allows you to..." by splitting into two
independent clauses (e.g., replace the comma with a period or semicolon) so it
reads correctly (for example: "All Novu template editors support LiquidJS. This
allows you to add logic and control flow to your notification content."). Update
the sentence in personalize-content.mdx where the phrase "All Novu template
editors support LiquidJS" appears.
In `@content/docs/platform/workflow/monitor-and-debug-workflow.mdx`:
- Around line 67-69: The "Common trace entries include:" list in the
documentation ends abruptly with only two items and no closing context; expand
this section by adding the missing common trace entries (e.g., "Task scheduled",
"Activity started", "Activity completed", "Child workflow started/completed",
"Workflow completed/failed") and append a short closing paragraph or
next-steps/diagnostics paragraph that summarizes how to interpret these traces
and links to related debugging guides; update the list near the existing "Common
trace entries include:" heading and ensure the file ends with a proper
concluding sentence or section header.
- Line 40: Update the sentence in the documentation where it reads "execution
details that shows" to use correct subject-verb agreement: change "details that
shows" to "details that show" so the plural noun "details" matches the plural
verb "show"; locate the phrase "execution details that shows how Novu processed
each step for a single subscriber" and replace "shows" with "show".
🧹 Nitpick comments (1)
content/docs/platform/workflow/create-a-workflow.mdx (1)
29-29: Parenthetical list is missing the Oxford comma before "and".Minor: "letters, numbers, hyphens, dots and underscores" — for consistency and clarity, add a comma before "and."
Proposed fix
- - **Identifier** (Required): The `workflowId` is immutable. It must be in a valid slug format (letters, numbers, hyphens, dots and underscores only) and must be unique within one environment. + - **Identifier** (Required): The `workflowId` is immutable. It must be in a valid slug format (letters, numbers, hyphens, dots, and underscores only) and must be unique within one environment.
content/docs/platform/workflow/add-and-configure-steps/configure-action-steps/delay.mdx
Show resolved
Hide resolved
content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx
Outdated
Show resolved
Hide resolved
content/docs/platform/workflow/add-notification-content/channels-template-editors.mdx
Outdated
Show resolved
Hide resolved
content/docs/platform/workflow/add-notification-content/personalize-content.mdx
Outdated
Show resolved
Hide resolved
content/docs/platform/workflow/add-notification-content/personalize-content.mdx
Outdated
Show resolved
Hide resolved
Comment on lines
+67
to
+69
| Common trace entries include: | ||
| - Workflow execution started | ||
| - Request subscriber processing completed No newline at end of file |
Contributor
There was a problem hiding this comment.
The file appears to end abruptly — the trace entries list looks incomplete.
The "Common trace entries include:" list has only two items and the file ends without any closing context or next-steps section. Is this intentional, or are additional trace entries and/or a closing paragraph missing?
🤖 Prompt for AI Agents
In `@content/docs/platform/workflow/monitor-and-debug-workflow.mdx` around lines
67 - 69, The "Common trace entries include:" list in the documentation ends
abruptly with only two items and no closing context; expand this section by
adding the missing common trace entries (e.g., "Task scheduled", "Activity
started", "Activity completed", "Child workflow started/completed", "Workflow
completed/failed") and append a short closing paragraph or
next-steps/diagnostics paragraph that summarizes how to interpret these traces
and links to related debugging guides; update the list near the existing "Common
trace entries include:" heading and ensure the file ends with a proper
concluding sentence or section header.
…ls-template-editors.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…alize-content.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…alize-content.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…ls-template-editors.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
Documentation
Chores