[DO NOT MERGE] Refine/cleanup the workflow concept page #887
Conversation
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe workflows concept documentation was rewritten to provide a concise, high-level overview. Detailed sections on workflow steps, editor features, identifiers, statuses, and other operational details were removed. The new version focuses on the overall flow and behavior of workflows, mentioning triggers, modular steps, and notification delivery, while omitting implementation specifics and examples. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Workflow
participant Editor/API
participant NotificationChannels
User->>Workflow: Triggers event
Workflow->>Workflow: Executes modular steps (channel/action/custom)
Workflow->>NotificationChannels: Delivers notifications via multiple channels
User->>Editor/API: Defines workflows using visual editor or API
Possibly related PRs
Poem
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 (3)
content/docs/platform/concepts/workflows.mdx (3)
9-9: Add Oxford comma + tighten wording for clarityMinor copy-editing to improve flow and parallelism.
-It acts as the central logic layer for routing messages across different channels and controlling what notification to send, when to send it and through which channels they are sent. +It acts as the central logic layer for routing messages across different channels and controls what notification to send, when to send it, and through which channels it is sent.
18-20: Re-phrase complex/simple sentenceThe current split into two sentences breaks the rhythm and reads awkwardly. Consider an em-dash construction instead.
-Workflows can be simple, for example, “when a user signs up, send them a welcome email.” Or complex, such as: +Workflows can be simple—for example, “when a user signs up, send them a welcome email”—or complex, such as:
44-44: Spell “multichannel” as one wordLanguageTool flags “multi-channel”. Industry docs typically use “multichannel”.
-... especially in multi-channel notification strategies. +... especially in multichannel notification strategies.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/docs/platform/concepts/workflows.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/concepts/workflows.mdx
[misspelling] ~44-~44: This word is normally spelled as one.
Context: ...xtend as your needs grow, especially in multi-channel notification strategies. Workflows als...
(EN_COMPOUNDS_MULTI_CHANNEL)
⏰ Context from checks skipped due to timeout of 90000ms (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/concepts/workflows.mdx (2)
26-29: Clear explanation of trigger & flow – looks goodThe trigger-to-steps description is concise and accurate.
54-56: Visual-editor mention reads wellGood balance between editor and API usage—no issues spotted.
jainpawan21
changed the title
Summary by CodeRabbit