[DO NOT MERGE] Clean up the topics core concept page #889
Conversation
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThe documentation for topics in Novu was streamlined to present a concise conceptual overview. Detailed explanations, usage instructions, code samples, API references, and FAQs were removed, focusing solely on describing topics as dynamic collections of subscribers for broadcasting messages, with an emphasis on their conceptual role and unique identifiers. Changes
Possibly related PRs
Suggested reviewers
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/topics.mdx (3)
7-9: Missing comma after an introductory clauseIn line 9, the phrase “direct user targeting while preserving per-subscriber preferences” reads more clearly with a comma after targeting:
- They help decouple your notification logic from direct user targeting while preserving per-subscriber preferences and personalization. + They help decouple your notification logic from direct user targeting, while preserving per-subscriber preferences and personalization.
34-38: Consider linking to the API reference fortopicKeycreationThe paragraph tells users that a topic is auto-created if it doesn't exist, but it doesn’t point them to the precise API endpoint/CLI command. Adding a short inline link (e.g.,
[Create topic API](/api/reference#create-topic)) would let readers immediately act on the information without hunting through docs.
40-44: Add a concrete “when to use topics” exampleYou nicely explain that topics are optional and complement individual targeting. A short, real-world use-case bullet (e.g., “Notify all staff on-call engineers during an incident”) would anchor the concept and help readers decide when to choose one approach over the other.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/docs/platform/concepts/topics.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/concepts/topics.mdx
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...our notification logic from direct user targeting while preserving per-subscriber prefere...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
content/docs/platform/concepts/topics.mdx (2)
9-10: Add a comma after “targeting” for better readabilityThe sentence currently reads a bit dense. Introducing a comma after “targeting” separates the clauses and improves flow.
-This helps decouple your notification logic from direct user targeting while preserving per-subscriber preferences and personalization. +This helps decouple your notification logic from direct user targeting, while preserving per-subscriber preferences and personalization.
38-40: Spell out implications of “auto-create” to avoid surprisesWhen a topic is implicitly created, readers may wonder about default properties (e.g., name, retention, quotas) or accidental proliferation across environments. A brief note such as “The topic is created with default settings and counts toward your environment limits” would pre-empt confusion.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/docs/platform/concepts/topics.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/concepts/topics.mdx
[uncategorized] ~9-~9: Possible missing comma found.
Context: ...our notification logic from direct user targeting while preserving per-subscriber prefere...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ 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
jainpawan21
changed the title
Summary by CodeRabbit