feat: restructured subscribers and topics documentation #958
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughAdds a new “Subscribers and Topics” subsection to the docs navigation, introduces its metadata, and creates an overview MDX page with conceptual guidance and next-step cards. No code logic or public APIs are changed. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
✨ 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. Comment |
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![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/subscribers-and-topics/overview.mdx (3)
8-11: Tighten wording (minor style).-Subscribers and topics are the foundation of how Novu delivers notifications at scale. Subscribers represent the individual entities who will receive notifications, while topics provide a way to group multiple subscribers under a shared identifier. +Subscribers and topics are the foundation of how Novu delivers notifications at scale. Subscribers are the individual recipients of notifications, while topics group multiple subscribers under a shared identifier. - -Together, they allow you to deliver notifications both at the individual level and to dynamic groups, ensuring messages are routed and personalized correctly for every recipient. +Together, they let you deliver notifications to individuals and dynamic groups, ensuring correct routing and personalization for every recipient.
14-17: Clarify/ground “immutability” of topicKey and add a reference link.If
topicKeyis strictly immutable in Novu, keep as-is and add a cross-reference; otherwise soften the claim.-Similarly, each topic is uniquely identified by a `topicKey`, an internal, permanent identifier that cannot be changed after creation. A topic key ensures that groups of subscribers can always be referenced consistently, regardless of how the topic is named or described. +Similarly, each topic is uniquely identified by a `topicKey`, a stable internal identifier used across APIs. A topic key ensures that groups of subscribers can always be referenced consistently, regardless of how the topic is named or described. See also: [/platform/concepts/topics](/platform/concepts/topics).
18-25: Grammar and clarity: prefer plural “environments” and Oxford comma.-## Subscribers, topics and environment +## Subscribers, topics, and environments @@ -Subscribers and topics are scoped to a specific environment. Novu uses isolated environments, typically Development, Production or Custom environments to separate testing data from live user data. +Subscribers and topics are scoped to a specific environment. Novu uses isolated environments—typically Development, Production, or custom—to separate test data from live user data. See [/platform/concepts/environments](/platform/concepts/environments) for details. @@ -This means a subscriber created in the Development environment is a completely separate entity from a subscriber with the same `subscriberId` in the Production environment. +A subscriber created in Development is completely separate from a subscriber with the same `subscriberId` in Production. @@ -This isolation is crucial for safe testing, as it prevents accidental notifications from being sent to real users from your development or staging setups. To target a subscriber in a different environment, they must be created within that environment. +This isolation prevents accidental notifications to real users during testing. To target a subscriber in a different environment, create that subscriber in that environment.content/docs/platform/meta.json (1)
34-35: Header spacing consistency.Most headers use no spaces around the dashes (e.g., “---Getting Started---”). Consider aligning:
-"---Subscribers and Topics ---", +"---Subscribers and Topics---",
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
content/docs/platform/meta.json(1 hunks)content/docs/platform/subscribers-and-topics/meta.json(1 hunks)content/docs/platform/subscribers-and-topics/overview.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 (6)
content/docs/platform/subscribers-and-topics/overview.mdx (3)
1-5: Front matter looks good.Title/description/icon are present and consistent with the rest of the docs.
6-6: Import path is correct. All instances ofCardandCardscomponents import from'fumadocs-ui/components/card'; there are no imports from'fumadocs-ui/components/cards'. No changes needed.
28-54: All card targets exist; maintain current title‐case and verb usage
- Verified href targets under
content/docs/platform/subscribers-and-topicsresolve correctly.- Titles consistently use title-case across docs; do not convert to sentence-case.
- Descriptions employ varied imperative verbs (Explore, Learn, Understand, View); no uniform change needed.
Likely an incorrect or invalid review comment.
content/docs/platform/subscribers-and-topics/meta.json (1)
1-3: Approve meta.json update:pagesincludes only"overview", the correspondingoverview.mdxfile exists, and the JSON is valid.content/docs/platform/meta.json (2)
35-35: Section wiring verified. Thecontent/docs/platform/subscribers-and-topics/meta.jsonfile exists and is valid JSON.
34-35: Update AI summary to reflect actual insertion point
The new entries appear after"workflow/translations", not after"workflow/tags". Adjust the summary accordingly.Likely an incorrect or invalid review comment.
…utes.mdx Co-authored-by: DianaHackmamba <[email protected]>
…utes.mdx Co-authored-by: DianaHackmamba <[email protected]>
…utes.mdx Co-authored-by: DianaHackmamba <[email protected]>
…utes.mdx Co-authored-by: DianaHackmamba <[email protected]>
* Content for the subscriber attributes page * Add content for subscriber reference * Update content/docs/platform/subscribers-and-topics/subscriber-attributes.mdx Co-authored-by: DianaHackmamba <[email protected]> * Update content/docs/platform/subscribers-and-topics/subscriber-attributes.mdx Co-authored-by: DianaHackmamba <[email protected]> * Update content/docs/platform/subscribers-and-topics/subscriber-attributes.mdx Co-authored-by: DianaHackmamba <[email protected]> * Update content/docs/platform/subscribers-and-topics/subscriber-attributes.mdx Co-authored-by: DianaHackmamba <[email protected]> * Fix changes based on Diana's feedback --------- Co-authored-by: DianaHackmamba <[email protected]>
Edit the overview page and add image
…s.mdx Co-authored-by: DianaHackmamba <[email protected]>
…s.mdx Co-authored-by: DianaHackmamba <[email protected]>
…s.mdx Co-authored-by: DianaHackmamba <[email protected]>
…s.mdx Co-authored-by: DianaHackmamba <[email protected]>
…s.mdx Co-authored-by: DianaHackmamba <[email protected]>
…s.mdx Co-authored-by: DianaHackmamba <[email protected]>
…s.mdx Co-authored-by: DianaHackmamba <[email protected]>
…s.mdx Co-authored-by: Pawan Jain <[email protected]>
…s.mdx Co-authored-by: Pawan Jain <[email protected]>
…s.mdx Co-authored-by: Pawan Jain <[email protected]>
…s.mdx Co-authored-by: Pawan Jain <[email protected]>
Folder structure
…s.mdx Co-authored-by: DianaHackmamba <[email protected]>
Mrk 1025 manage subscribers
Preferences page
Content for the manage topics page
Content for trigger workflow page
Summary by CodeRabbit
New Features
Documentation