Skip to content

Conversation

@Aviatorscode2
Copy link
Contributor

@Aviatorscode2 Aviatorscode2 commented Jul 31, 2025

Summary by CodeRabbit

  • New Features

    • Added new documentation pages for Inbox setup, navigation, customization, configuration, advanced customization, localization, and tabs.
    • Introduced metadata files to organize and enhance navigation for documentation sections.
  • Bug Fixes

    • Updated titles and metadata for several documentation pages for clarity and consistency.
  • Documentation

    • Removed outdated React-specific documentation for Inbox styling, localization, and tabs.
    • Simplified and restructured documentation navigation metadata for improved usability.

@linear
Copy link

linear bot commented Jul 31, 2025

MRK-949 Localization

@netlify
Copy link

netlify bot commented Jul 31, 2025

Deploy Preview for docs-novu ready!

Name Link
🔨 Latest commit e9775d3
🔍 Latest deploy log https://app.netlify.com/projects/docs-novu/deploys/688bce517e8abf000827fc47
😎 Deploy Preview https://deploy-preview-917--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.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 31, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This update introduces multiple new documentation pages and metadata files for the Novu Inbox component, advanced customization, and configuration sections. It restructures navigation metadata, updates several document titles, and removes legacy React-specific styling, tabs, and localization documentation, consolidating and modernizing the documentation structure.

Changes

Cohort / File(s) Change Summary
New Inbox Documentation Pages
content/docs/platform/inbox/setup-inbox.mdx, .../navigation-and-events.mdx, .../configuration/styling.mdx, .../configuration/tabs.mdx, .../configuration/data-object.mdx, .../configuration/snooze.mdx, .../advanced-customization/custom-notification.mdx, .../advanced-customization/custom-bell.mdx, .../advanced-customization/render-html-content.mdx, .../localization.mdx
Added new documentation files covering Inbox setup, navigation, configuration (styling, tabs, data object, snooze), advanced customization, rendering HTML content, and localization.
Metadata Additions and Updates
content/docs/platform/inbox/meta.json, .../configuration/meta.json, .../advanced-customization/meta.json, .../concepts/meta.json
Added or updated JSON metadata files to define navigation, titles, icons, pages, and descriptions for Inbox, configuration, advanced customization, and concepts sections.
Inbox Documentation Title and Metadata Updates
.../prepare-for-production.mdx, .../migration-guide.mdx, .../headless.mdx
Updated document titles and metadata for production setup, migration guide, and headless mode usage.
Concepts Documentation Structure Changes
content/docs/platform/meta.json, .../concepts/meta.json
Simplified and restructured the concepts section navigation metadata, consolidating individual concept pages into a single entry.
Inbox React Documentation Removals
.../react/styling.mdx, .../react/tabs.mdx, .../react/localization.mdx
Removed legacy React-specific documentation for styling, tabs, and localization.
Inbox Notification Event Title Update
.../concepts/notification-event.mdx
Changed the document title from "Notifications" to "Notification event."

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocsNav
    participant InboxDocs
    participant MetaFiles

    User->>DocsNav: Navigates to Inbox documentation
    DocsNav->>MetaFiles: Reads metadata (meta.json) for navigation structure
    DocsNav->>InboxDocs: Loads selected documentation page (e.g., setup, configuration)
    InboxDocs-->>User: Renders documentation content
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • novuhq/docs#855: Adds new metadata and documentation files for Inbox and Concepts, including a "Set up the Inbox" page—directly related to the introduction of new Inbox documentation and metadata in this PR.
  • novuhq/docs#874: Updates content within individual concept pages; both PRs modify the "Concepts" section, with this PR focusing on metadata and navigation structure.
  • novuhq/docs#890: Refines integrations documentation content, while this PR updates metadata for the same section.

Suggested reviewers

  • jainpawan21
  • DianaHackmamba

Poem

In the warren of docs, new pages appear,
With Inbox and Concepts now crystal clear.
Metadata bunnies hop to and fro,
Organizing sections in a tidy row.
Old React docs burrow away—
Fresh carrots for readers, hip-hip-hooray!
🥕✨

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch MRK-949-localization

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 generate unit tests to generate unit tests for 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.

@Aviatorscode2 Aviatorscode2 changed the base branch from main to MRK-935-inbox-architecture July 31, 2025 20:13
@jainpawan21 jainpawan21 merged commit 949c32e into MRK-935-inbox-architecture Aug 1, 2025
2 of 3 checks passed
@jainpawan21 jainpawan21 deleted the MRK-949-localization branch August 1, 2025 09:43
@coderabbitai coderabbitai bot mentioned this pull request Aug 6, 2025
jainpawan21 added a commit that referenced this pull request Aug 27, 2025
* Content for the set up the inbox component page (#896)

* Rearrange the core concept section

* Structure the inbox section

* Content for the set up the inbox component page

* Update content/docs/platform/inbox/setup-inbox.mdx

Co-authored-by: Pawan Jain <[email protected]>

* Update content/docs/platform/inbox/setup-inbox.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/setup-inbox.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/setup-inbox.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/setup-inbox.mdx

* Update EU region code sample

---------

Co-authored-by: Pawan Jain <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>

* Inbox section (#906)

* Rearrange the core concept section

* Structure the inbox section

* Content for tabs (#907)

* Content for tabs

* Update content/docs/platform/inbox/configuration/tabs.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/configuration/tabs.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content for tabs based on feedback

* Update content/docs/platform/inbox/configuration/tabs.mdx

* Update content/docs/platform/inbox/configuration/tabs.mdx

---------

Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: Pawan Jain <[email protected]>

* Content for styling and theming. Including the docs for Icons here for now. (#908)

* Content for snooze page (#914)

* Content for icons page (#913)

* Content for icons page

* Update content/docs/platform/inbox/configuration/icons.mdx

Co-authored-by: Pawan Jain <[email protected]>

* Update content/docs/platform/inbox/configuration/icons.mdx

Co-authored-by: Pawan Jain <[email protected]>

* Update Gif and content

---------

Co-authored-by: Pawan Jain <[email protected]>

* Mrk 946 preferences (#909)

* Content for preferences

* Update content

* Update content for preferences page

* Change component name to match behaviuor

* Content for Data object page and also fix data object positioning (#912)

* Content for Data object page and also fix data object positioning

* add data object keys limit

---------

Co-authored-by: Pawan Jain <[email protected]>

* Mrk 949 localization (#917)

* Update styling.mdx

* Update styling.mdx

* fix: lint issues

* fix: format issue

* Update localization.mdx (#926)

* Update data-object.mdx (#923)

* Update preferences.mdx (#922)

* Update icons.mdx (#924)

* Update snooze.mdx (#925)

* Update base on Diana's feedback

* Mrk 939 advanced customization (#918)

* Content for renderbody, renderSubject and renderNotification

* Added content to the custom notification page

* Content for the display HTML in notfications page

* Update description

* Restructure the name and writiign content for customize bell and popover page

* Content for the bell and popover and added content to customize notification ui

* Update content/docs/platform/inbox/advanced-customization/customize-bell-and-popover.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-bell-and-popover.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/html-in-notifications.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/html-in-notifications.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update based on feedback

* Update content/docs/platform/inbox/advanced-customization/html-in-notifications.mdx

---------

Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: Pawan Jain <[email protected]>

* fix: add migration guide doc

* Mrk 940 prepare for production (#928)

* Content for the Prepare for production page

* Change page title

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* add number list to Novu branding section

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update based on feedback from Diana

* Update content/docs/platform/inbox/prepare-for-production.mdx

* Update content/docs/platform/inbox/prepare-for-production.mdx

* fix: update socket url

---------

Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: Pawan Jain <[email protected]>

* Content for the headless mode (#927)

* Content for the headless mode

* Update content/docs/platform/inbox/headless-mode.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/headless-mode.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/headless-mode.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* update base on feedback from Diana

* fix: lint issue

* Update content/docs/platform/inbox/headless-mode.mdx

---------

Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: Pawan Jain <[email protected]>

* Content for Notification click behavior (#916)

* fix: update hmac link

* Edit styling page (#920)

* Update styling.mdx

* fix: format mailersend code snippet

* fix: the type in the variables section of appearance prop

* fix: lint issues

* fix: format issue

* fix: lint and format issue

* Update localization.mdx (#926)

* Update data-object.mdx (#923)

* Update preferences.mdx (#922)

* Update icons.mdx (#924)

* Update snooze.mdx (#925)

* Update styling.mdx

* Update base on Diana's feedback

* Mrk 939 advanced customization (#918)

* Content for renderbody, renderSubject and renderNotification

* Added content to the custom notification page

* Content for the display HTML in notfications page

* Update description

* Restructure the name and writiign content for customize bell and popover page

* Content for the bell and popover and added content to customize notification ui

* Update content/docs/platform/inbox/advanced-customization/customize-bell-and-popover.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-bell-and-popover.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/html-in-notifications.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/html-in-notifications.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/advanced-customization/customize-notification-ui.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update based on feedback

* Update content/docs/platform/inbox/advanced-customization/html-in-notifications.mdx

---------

Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: Pawan Jain <[email protected]>

* Mrk 940 prepare for production (#928)

* Content for the Prepare for production page

* Change page title

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* add number list to Novu branding section

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/prepare-for-production.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update based on feedback from Diana

* Update content/docs/platform/inbox/prepare-for-production.mdx

* Update content/docs/platform/inbox/prepare-for-production.mdx

* fix: update socket url

---------

Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: Pawan Jain <[email protected]>

* Content for the headless mode (#927)

* Content for the headless mode

* Update content/docs/platform/inbox/headless-mode.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/headless-mode.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/headless-mode.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* update base on feedback from Diana

* fix: lint issue

* Update content/docs/platform/inbox/headless-mode.mdx

---------

Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: Pawan Jain <[email protected]>

* Content for Notification click behavior (#916)

---------

Co-authored-by: Pawan Jain <[email protected]>
Co-authored-by: Paweł Tymczuk <[email protected]>
Co-authored-by: Aviatorscode2 <[email protected]>
Co-authored-by: Victor Yakubu <[email protected]>

* fix: update multitenancy doc

* Update content/docs/platform/inbox/migration-guide.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/migration-guide.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/migration-guide.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/migration-guide.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/migration-guide.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content

* Update content

* Content for the introduction (#933)

* Content for the introduction

* Update content/docs/platform/inbox/overview.mdx

---------

Co-authored-by: Pawan Jain <[email protected]>

* Clean up for inbox section (#947)

* Clean up for inbox section

* Update content/docs/platform/inbox/migration-guide.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/configuration/meta.json

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/migration-guide.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Update content/docs/platform/inbox/setup-inbox.mdx

Co-authored-by: DianaHackmamba <[email protected]>

* Clarify spelling issue in the Avator icons section

* Update content/docs/platform/inbox/migration-guide.mdx

Co-authored-by: DianaHackmamba <[email protected]>

---------

Co-authored-by: DianaHackmamba <[email protected]>

* Mrk 1018 inbox feedback (#951)

* Implemet feedback

* Work on the content of the advanced customization section creating two new pages

* Remove the hide global preference docs

* Apply prettier on the code and also a callout for renderNotifications

* Update docs for tabs based on feedback from Dima

* remove in-app avatar docs from the icons and edit the icons page

* edit the page description for the icons pages

* Add accordion to the multi tenancy docs

* fix: add hide global preference from ui using appearance prop

---------

Co-authored-by: Pawan Jain <[email protected]>

* Update stying page with notification severity docs (#952)

* Update stying page with notification severity docs

* Add  docs for notification severity in tabs page

* Update customize bell page with example showing how to create custom bell that shows the number of notifications with high severity

* Update content/docs/platform/inbox/advanced-customization/customize-bell.mdx

* fix: lint issue due to bell

---------

Co-authored-by: Pawan Jain <[email protected]>

* fix: remove meta.json from concepts

* fix: meta.json file to include concepts

---------

Co-authored-by: Victor Yakubu <[email protected]>
Co-authored-by: DianaHackmamba <[email protected]>
Co-authored-by: Aviatorscode2 <[email protected]>
Co-authored-by: Paweł Tymczuk <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants