docs icon indicating copy to clipboard operation
docs copied to clipboard

Channels providers integration [Do not merge yet]

Open Aviatorscode2 opened this issue 1 month ago • 2 comments

Summary by CodeRabbit

  • Documentation
    • Revamped SMS integration docs into a guided, step-by-step workflow.
    • Added a “Target a specific provider” approach with prescriptive guidance for triggering by integration identifier.
    • Introduced a “Supported providers” gallery with provider cards.
    • Reworked integrations overview to clarify Provider vs Integration, scoping, primary vs active, and overrides.
    • Added Channel overrides and expanded Provider override scopes, including guidance for sending provider-specific extra fields.
    • Updated examples/annotations and removed deprecated sections.

Aviatorscode2 avatar Nov 07 '25 14:11 Aviatorscode2

Deploy Preview for docs-novu ready!

Name Link
Latest commit 458257fb09b9d0de31de57da8e0da21286989418
Latest deploy log https://app.netlify.com/projects/docs-novu/deploys/69356f3f9acb760008c3e94e
Deploy Preview https://deploy-preview-1004--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 Nov 07 '25 14:11 netlify[bot]

Walkthrough

Restructures integration docs into provider-centric, stepwise workflows for Email, SMS, Push, and Chat; introduces provider galleries and "target a specific provider" guidance; expands Integrations overview with Provider vs Integration and override scopes; adds demo integration page and updates navigation/meta files. No public API changes.

Changes

Cohort / File(s) Summary of Changes
SMS: workflow & provider catalog
content/docs/platform/integrations/sms/index.mdx
Rewrote SMS docs into a guided step flow, added "Target a specific provider" guidance and inline trigger override annotations, introduced a supported‑providers gallery, and removed deprecated sections.
SMS metadata
content/docs/platform/integrations/sms/meta.json
Updated pages to reference providers index (["(providers)"]).
Integrations overview
content/docs/platform/integrations/overview.mdx
Added Provider vs Integration definitions, primary vs active integrations, environment scoping, and override semantics; refreshed integration cards.
Trigger overrides & provider scopes
content/docs/platform/integrations/trigger-overrides.mdx
Added Channel overrides note (Email/SMS), renamed/expanded provider override scopes, added "Sending extra fields supported by provider SDK" with passthrough JSON example, and simplified step-level examples.
Email: workflow & provider catalog
content/docs/platform/integrations/email/index.mdx
Converted Email docs to step-based flow (add provider, add channel, define content, store subscriber, trigger), added attachments guidance, sending/targeting overrides, and Supported Providers gallery; updated payload shapes and annotations.
Email metadata
content/docs/platform/integrations/email/meta.json
Replaced pages list with ["(providers)", "activity-tracking"].
Push: flows, token mgmt & provider cards
content/docs/platform/integrations/push/index.mdx, content/docs/platform/integrations/push/adding-push.mdx
Replaced Tabs with Steps, reworked conceptual text, added extensive device token management flows and examples, replaced provider list with Cards; removed content from adding-push.mdx.
Push providers (many)
content/docs/platform/integrations/push/(providers)/*.mdx
Substantial rewrites across APNS, FCM, Expo, OneSignal, Push Webhook, Pusher Beams, Pushpad to a stepwise setup/usage format, updated credentials and overrides examples, and added integrationIdentifier guidance.
Chat: workflow & provider catalog
content/docs/platform/integrations/chat/index.mdx
Reorganized Chat docs into steps (add provider, define content, store credentials, trigger), updated provider auth notes, and added Supported Providers gallery.
Demo integrations
content/docs/platform/integrations/demo-integration.mdx, content/docs/platform/integrations/demo-providers.mdx
Added new demo-integration.mdx describing sandbox demo integrations and limits; removed old demo-providers.mdx content.
Navigation / meta updates
content/docs/platform/integrations/meta.json, content/docs/platform/meta.json, content/docs/platform/integrations/*/meta.json
Adjusted pages order and names (inserted demo-integration, moved trigger-overrides), set several pages to ["(providers)"], and renamed header label to ---Integrate Channels Providers---.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

  • Files to focus on:
    • content/docs/platform/integrations/sms/index.mdx — verify trigger override examples and inline annotation markers.
    • content/docs/platform/integrations/email/index.mdx — check Steps components, attachments/payload shape changes, and provider gallery links.
    • content/docs/platform/integrations/push/* — confirm token management examples and consistency across provider pages.
    • content/docs/platform/integrations/*/meta.json — ensure navigation ordering and "(providers)" entries align with site structure.

Possibly related PRs

  • novuhq/docs#986 — Overlapping rewrites to the FCM provider doc (credentials, triggers, runtime overrides).
  • novuhq/docs#990 — Similar restructuring and expanded examples for Push Webhook provider doc.
  • novuhq/docs#988 — Related extensive edits to the APNS provider documentation and trigger/override examples.

Suggested reviewers

  • DianaHackmamba
  • djabarovgeorge
  • ChmaraX

Poem

A rabbit hops through docs so bright,
Cards of providers line the night.
Steps to add, target, trigger, send —
Overrides guide each careful blend.
Thump — the message finds its flight! 🐇📨

Pre-merge checks and finishing touches

✅ Passed checks (3 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 changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The PR title 'Channels providers integration' directly reflects the primary changes: restructuring documentation to center on channel providers (Email, SMS, Push, Chat) with new provider-centric workflows and provider galleries throughout.
✨ Finishing touches
  • [ ] 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • [ ] Create PR with unit tests
  • [ ] Post copyable unit tests in a comment
  • [ ] Commit unit tests in branch channels-providers-integration

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.

coderabbitai[bot] avatar Nov 07 '25 14:11 coderabbitai[bot]