docs
docs copied to clipboard
feat: restructured subscribers and topics documentation
Summary by CodeRabbit
-
New Features
- Introduced a “Subscribers and Topics” subsection under Building Workflows.
- Added an Overview page outlining Subscriber ID, Topic Key, and environment isolation.
- Included quick links to Subscriber Attributes, Managing Subscribers, Subscriber Preferences, Activity Feed, and Topics.
-
Documentation
- Expanded navigation to include the new subsection and overview.
- Added metadata to surface the overview page within the docs.
- Improved cross-linking via cards for faster discovery of related subscriber and topic resources.
[!IMPORTANT]
Review skipped
Draft detected.
Please check the settings in the CodeRabbit UI or the
.coderabbit.yamlfile in this repository. To trigger a single review, invoke the@coderabbitai reviewcommand.You can disable this status message by setting the
reviews.review_statustofalsein the CodeRabbit configuration file.
Walkthrough
Adds 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
| Cohort / File(s) | Summary |
|---|---|
| Docs navigation update `content/docs/platform/meta.json` |
Inserts a new section header "---Subscribers and Topics ---" and a page reference "...subscribers-and-topics" after "workflow/tags" and before "---Channels---". |
| Subscribers and Topics docs scaffold `content/docs/platform/subscribers-and-topics/meta.json` |
Adds metadata specifying the pages array: ["overview"]. |
| Subscribers and Topics overview page `content/docs/platform/subscribers-and-topics/overview.mdx` |
Adds MDX page with front matter, conceptual sections (identifiers, environment isolation), and a “Next steps” card grid linking to related topics. |
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
- novuhq/docs#917 — Also updates content/docs/platform/meta.json to adjust navigation around subscribers/topics; likely part of the same documentation area.
Suggested reviewers
- Aviatorscode2
- DianaHackmamba
Poem
I hop through docs with gentle paws,
Nesting topics under tidy laws.
Cards aligned, a burrow of links,
Subscribers labeled—no missing kinks.
New paths sprout where carrots grow,
Tap “overview,” and off we go! 🥕🐇
✨ Finishing touches
🧪 Generate unit tests
- [ ] Create PR with unit tests
- [ ] Post copyable unit tests in a comment
- [ ] Commit unit tests in branch
MRK-1022-subscribers-and-topics
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 @coderabbitai help to get the list of available commands and usage tips.
Deploy Preview for docs-novu ready!
| Name | Link |
|---|---|
| Latest commit | f0c32336d345407d6c35de0d9f46ff8fc94a4461 |
| Latest deploy log | https://app.netlify.com/projects/docs-novu/deploys/68c349b5d6c73a0008c71da6 |
| Deploy Preview | https://deploy-preview-958--docs-novu.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify project configuration.