docs icon indicating copy to clipboard operation
docs copied to clipboard

[Do NOT MERGE] Clean up the subscribers concept page

Open Aviatorscode2 opened this issue 5 months ago β€’ 2 comments

Summary by CodeRabbit

  • Documentation
    • Streamlined the "Subscribers" documentation to focus on core concepts, emphasizing unique subscriber identification and their role in personalized notifications and workflow targeting. Detailed explanations and FAQs have been removed for brevity.

Aviatorscode2 avatar Jun 30 '25 14:06 Aviatorscode2

Walkthrough

The documentation for the "Subscribers" concept in Novu has been significantly condensed, with detailed sections about metadata, management, preferences, and personalization removed. The revised content now focuses on the core definition and purpose of subscribers, emphasizing their unique identification and role in workflow targeting and personalization.

Changes

File(s) Change Summary
content/docs/platform/concepts/subscribers.mdx Condensed documentation by removing detailed explanations, focusing on the core concept and role of subscribers.

Possibly related PRs

  • novuhq/docs#874: Also modifies the subscribers documentation, but by expanding it with examples, API references, and FAQs, indicating an overlap in documentation scope.

Poem

πŸ‡
Hopped through docs with nimble feet,
Trimmed the words to make them neat.
Subscribers now stand clear and bright,
Their purpose shown in focused light.
No more fluff, just what you needβ€”
For every workflow, they're the seed!
🌱


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.

❀️ Share
πŸͺ§ Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 30 '25 14:06 coderabbitai[bot]

Deploy Preview for docs-novu ready!

Name Link
Latest commit c13af50fad7d48cfb80abd9817ae0a6afef62789
Latest deploy log https://app.netlify.com/projects/docs-novu/deploys/68629b2b2630b1000858edef
Deploy Preview https://deploy-preview-888--docs-novu.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Jun 30 '25 14:06 netlify[bot]