Skip to content

docs: add keyless mode section to Inbox documentation #855

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
May 30, 2025
Merged

docs: add keyless mode section to Inbox documentation #855

merged 4 commits into from
May 30, 2025

Conversation

@djabarovgeorge
Copy link
Contributor

@djabarovgeorge djabarovgeorge commented May 20, 2025 •
edited by coderabbitai bot
Loading

  • Introduced a new section explaining the Keyless mode for the <Inbox /> component, allowing users to test and explore features without prior setup.
  • Included a code example for integrating the Inbox component in a React application.
  • Added a callout encouraging users to sign up for a full experience with Novu Cloud.

Summary by CodeRabbit

  • Documentation
    • Added a new section describing "Keyless Mode" for the Inbox React component, allowing instant integration and testing without authentication keys.
    • Provided a minimal usage example and guidance for enabling navigation.
    • Included an informational callout clarifying limitations of keyless mode.
    • Fixed minor typographic issues in the documentation.

@djabarovgeorge
docs: add keyless mode section to Inbox documentation
5a16c58 
- Introduced a new section explaining the Keyless mode for the `<Inbox />` component, allowing users to test and explore features without prior setup.
- Included a code example for integrating the Inbox component in a React application.
- Added a callout encouraging users to sign up for a full experience with Novu Cloud.
@netlify
Copy link

netlify bot commented May 20, 2025 •
edited
Loading

✅ Deploy Preview for docs-novu ready!

Name Link
🔨 Latest commit 3f86800
🔍 Latest deploy log https://app.netlify.com/projects/docs-novu/deploys/6839ef1a3327de00085bc834
😎 Deploy Preview https://deploy-preview-855--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.

jainpawan21
jainpawan21 requested changes May 27, 2025
View reviewed changes
@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 30, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The documentation for the <Inbox /> React component was updated to add a new section describing "Keyless Mode," which allows users to try the component without authentication keys. The update includes a minimal usage example, an informational callout, and minor typographic corrections.

Changes

File(s) Change Summary
content/docs/platform/inbox/react/components/inbox.mdx Added "Keyless Mode" section with minimal example and informational callout; fixed typographic errors (curly to straight apostrophes).

Poem

A new mode for Inbox, so easy and bright,
Try it keyless, no setup in sight!
A callout appears, with info to share,
For quick exploration, just render with care.
Straightened apostrophes hop through the text—
This bunny loves docs that are simple and next!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3b93022 and 3f86800.

📒 Files selected for processing (1)
  • content/docs/platform/inbox/react/components/inbox.mdx (3 hunks)

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]
coderabbitai bot reviewed May 30, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (1)
content/docs/platform/inbox/react/components/inbox.mdx (1)

32-34: Duplicate Callout Content

This callout content matches the suggestion made by jainpawan21 in a previous review.

🧹 Nitpick comments (4)
content/docs/platform/inbox/react/components/inbox.mdx (4)

11-14: Consistent Capitalization for 'Keyless Mode'

The header uses “Keyless Mode” (capitalized “Mode”) but the paragraph text uses “Keyless mode” (lowercase “mode”). For clarity, pick one style and apply it consistently in both the heading and body.

15-30: Optimize React Import in the Example

Since React 17+ supports JSX without an explicit import React from 'react';, you may remove that import to streamline the snippet. If you keep it for backward compatibility, consider noting that it’s optional in newer React versions.

159-159: Highlight Timezone Note

Consider wrapping this standalone sentence in a <Callout type="info"> so it stands out like other informational nuggets (e.g., snooze constraints) and doesn’t get overlooked in the prose.

205-205: Refine Custom Tabs Guidance

To improve readability, rephrase to active voice. For example:
“To add a Snoozed or Reminders tab when using custom tabs in <Inbox />, include snoozed: true in your tabs configuration.”

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9ef0be6 and 3b93022.

📒 Files selected for processing (1)
  • content/docs/platform/inbox/react/components/inbox.mdx (3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build and Lint
  • GitHub Check: Redirect rules - docs-novu
  • GitHub Check: Header rules - docs-novu
  • GitHub Check: Pages changed - docs-novu

@jainpawan21 jainpawan21 merged commit 7b54ae1 into main May 30, 2025
4 of 6 checks passed
@jainpawan21 jainpawan21 deleted the keyless-guide branch May 30, 2025 17:48
This was referenced Jul 31, 2025
Merged
Merged
@coderabbitai coderabbitai bot mentioned this pull request Aug 13, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@jainpawan21 jainpawan21 jainpawan21 approved these changes

@Aviatorscode2 Aviatorscode2 Awaiting requested review from Aviatorscode2 Aviatorscode2 is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@djabarovgeorge @jainpawan21