Skip to content

Conversation

@Aviatorscode2
Copy link
Contributor

@Aviatorscode2 Aviatorscode2 commented Oct 7, 2025

Summary by CodeRabbit

  • Documentation
    • Added guidance and an example showing how to hide workflows and certain preferences from the subscriber preferences UI via appearance settings.
    • Introduced callouts explaining how to hide Schedule and Snooze features, and added links to styling guidance.
    • Clarified that the workflow name in preferences is the dashboard name and emphasized styling of Inbox elements.
    • Reordered Schedule docs to present guidance before the image and removed a redundant conditional-display example from styling docs.

@linear
Copy link

linear bot commented Oct 7, 2025

@netlify
Copy link

netlify bot commented Oct 7, 2025

Deploy Preview for docs-novu ready!

Name Link
🔨 Latest commit 836e5db
🔍 Latest deploy log https://app.netlify.com/projects/docs-novu/deploys/68e6730f846a480008cbe03c
😎 Deploy Preview https://deploy-preview-981--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 Oct 7, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Updates Inbox documentation: adds callouts explaining that workflows and features can be hidden via the appearance prop, moves a conditional-display preferences example into preferences.mdx (removed from styling.mdx), clarifies workflow naming and Inbox UI phrasing, and reorders/augments Schedule and Snooze docs around their images. All changes are documentation-only.

Changes

Cohort / File(s) Summary of Changes
Inbox Preferences & Styling
content/docs/platform/inbox/configuration/preferences.mdx, content/docs/platform/inbox/configuration/styling.mdx
preferences.mdx: add informational callouts about hiding workflows via appearance, add "Conditionally display preferences" section with a TypeScript/TSX example, clarify that displayed workflow name is the dashboard name, adjust wording about channel steps, and add styling callout. styling.mdx: remove the previous conditional-display guidance and its example; retain styling-by-severity content.
Inbox Feature Pages
content/docs/platform/inbox/features/schedule.mdx, content/docs/platform/inbox/features/snooze.mdx
schedule.mdx: insert callout about hiding Schedule via appearance before the schedule image and reorder content. snooze.mdx: add callout about hiding Snooze via appearance before the snooze image. No behavior or logic changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • DianaHackmamba
  • Aviatorscode2

Poem

In the meadow of docs I hop with cheer,
Tweaking prefs and snooze so guidance is clear.
Schedule now whispers, “hide me if you dare,”
Appearance props flutter like code-scented air.
I nibble on callouts, concise and bright—
Thump! The inbox is tidy, just right. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The title “fix: inbox feedback MRK 1069” references an internal ticket and broadly mentions inbox feedback but does not clearly convey the specific documentation updates made in this changeset. It fails to summarize the core additions of callouts and conditional display guidance for preferences, styling, schedule, and snooze features, making it difficult for a teammate to understand the primary change at a glance. Please revise the title to concisely reflect the main documentation changes, for example: “docs(inbox): add callouts for conditional hiding of preferences, schedule, and snooze features” so that it clearly describes the core updates without referencing the ticket number.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 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 7ce18ad and 836e5db.

📒 Files selected for processing (1)
  • content/docs/platform/inbox/configuration/preferences.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

Comment @coderabbitai help to get the list of available commands and usage tips.

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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c24815 and 7ce18ad.

📒 Files selected for processing (4)
  • content/docs/platform/inbox/configuration/preferences.mdx (3 hunks)
  • content/docs/platform/inbox/configuration/styling.mdx (0 hunks)
  • content/docs/platform/inbox/features/schedule.mdx (1 hunks)
  • content/docs/platform/inbox/features/snooze.mdx (1 hunks)
💤 Files with no reviewable changes (1)
  • content/docs/platform/inbox/configuration/styling.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Redirect rules - docs-novu
  • GitHub Check: Header rules - docs-novu
  • GitHub Check: Pages changed - docs-novu
  • GitHub Check: Build and Lint

@jainpawan21 jainpawan21 changed the title Fix docs issues raised by a client fix: inbox feedback MRK 1069 Oct 8, 2025
@jainpawan21 jainpawan21 merged commit c4f8f03 into main Oct 8, 2025
4 of 5 checks passed
@jainpawan21 jainpawan21 deleted the MRK-1069 branch October 8, 2025 14:20
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