Fix naming convention #877
Conversation
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe documentation for the React Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (4)
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/inbox/react/components/preferences.mdx (1)
62-62: Align descriptive text with grouping terminology
The sentence “Here are the key ways to filter preferences:” still refers to “filter.” Consider updating it to “Here are the key ways to group preferences:”.- Here are the key ways to filter preferences: + Here are the key ways to group preferences:content/docs/platform/inbox/react/components/inbox.mdx (2)
151-151: Grammar: remove colon before list introduction
Avoid a colon after “such as” when introducing the list. For example:- You can pass data such as: + You can pass data such as the following🧰 Tools
🪛 LanguageTool
[typographical] ~151-~151: Do not use a colon (:) before a series that is introduced by a preposition (‘as’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...dividual users. You can pass data such as: *reactionType: To display specific i...(RP_COLON)
320-320: Normalize heading sentence case
Several headings use Title Case for the final word (“Item”, “Subject”, “Body”, “Filtering Preferences”). Convert to sentence case for consistency:
- “Custom notification item”
- “Custom notification subject”
- “Custom notification body”
- “Filtering preferences”
Also applies to: 341-341, 363-363, 545-545
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
content/docs/platform/inbox/react/components/inbox.mdx(12 hunks)content/docs/platform/inbox/react/components/preferences.mdx(4 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/inbox/react/components/inbox.mdx
[typographical] ~151-~151: Do not use a colon (:) before a series that is introduced by a preposition (‘as’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...dividual users. You can pass data such as: * reactionType: To display specific i...
(RP_COLON)
⏰ 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 (5)
content/docs/platform/inbox/react/components/preferences.mdx (4)
64-64: Heading terminology updated correctly
The change from “#### Filter by tags” to “#### Group by tags” aligns with the grouping feature semantics.
79-79: Heading terminology updated correctly
“#### Group by tags and workflow IDs” clearly conveys the combined grouping criteria.
96-96: Heading terminology updated correctly
“#### Group all workflows” accurately describes including every workflow in the group.
110-110: Heading terminology updated correctly
“#### Group using custom logic” correctly replaces the earlier “Custom filtering logic.”content/docs/platform/inbox/react/components/inbox.mdx (1)
144-189: Well-structured Data object section
The newly introduced “Data object” section is clear, comprehensive, and placed logically before downstream examples. It covers static/dynamic values, usage, and TS type safety with practical code snippets and imagery.🧰 Tools
🪛 LanguageTool
[typographical] ~151-~151: Do not use a colon (:) before a series that is introduced by a preposition (‘as’). Remove the colon or add a noun or a noun phrase after the preposition.
Context: ...dividual users. You can pass data such as: *reactionType: To display specific i...(RP_COLON)
jainpawan21
left a comment
jainpawan21
left a comment
There was a problem hiding this comment.
@victorbmlabs
Please look into coderabbit suggestions
|
Kindly merge when you can @jainpawan21 |
Summary
Summary by CodeRabbit
<Inbox />component documentation with a detailed section on thedataobject, including usage examples, best practices, type safety guidance, and a warning about sensitive data.