docs icon indicating copy to clipboard operation
docs copied to clipboard

[DO NOT MERGE] Clean up the topics core concept page

Open Aviatorscode2 opened this issue 5 months ago • 2 comments

Summary by CodeRabbit

  • Documentation
    • Streamlined the topics documentation to provide a concise conceptual overview, focusing on key concepts and usage. Detailed examples, API instructions, and FAQs were removed for clarity.

Aviatorscode2 avatar Jun 30 '25 14:06 Aviatorscode2

Deploy Preview for docs-novu ready!

Name Link
Latest commit abdec0d874add35a2289e01e59fff5ffff4e4475
Latest deploy log https://app.netlify.com/projects/docs-novu/deploys/686b9fb93a5cc00008ab151c
Deploy Preview https://deploy-preview-889--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]

Walkthrough

The 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

File(s) Change Summary
content/docs/platform/concepts/topics.mdx Condensed and refocused the topics documentation to a high-level conceptual overview; removed detailed explanations, usage instructions, code samples, API references, and FAQs.

Possibly related PRs

  • novuhq/docs#878: Expanded the topics documentation with comprehensive how-to content and examples, which were removed in this PR to condense the documentation.

Suggested reviewers

  • Aviatorscode2

Poem

In the warren of docs, we trimmed and pruned,
Leaving just the essence, the concept attuned.
No more long examples, nor API parade—
Just a crisp overview, simply conveyed.
🥕
For every topic, a key remains true—
As the docs grow lean, so Novu hops anew!


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]