-
Couldn't load subscription status.
- Fork 111
Update content for APNS push guide #988
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.
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
base: push-provider-guides
Are you sure you want to change the base?
Conversation
❌ Deploy Preview for docs-novu failed. Why did it fail? →
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughRestructured and expanded APNS integration documentation to provide a comprehensive end-to-end configuration guide, including credential setup, Novu connection steps, subscriber token management via API examples, notification sending, and customization payloads, while removing outdated pre-trigger setup content. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 4
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
public/images/channels-and-providers/push/apns/apns-integration.pngis excluded by!**/*.png
📒 Files selected for processing (1)
content/docs/platform/integrations/push/(providers)/apns.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/integrations/push/(providers)/apns.mdx
[grammar] ~39-~39: Ensure spelling is correct
Context: ...ields and under the Delivery Provider Crendetials section fill in the following fields:...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ 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
🔇 Additional comments (1)
content/docs/platform/integrations/push/(providers)/apns.mdx (1)
103-116: Update documentation to use consistent SDK package across examples.The code snippet uses
@novu/node, but the official TypeScript SDK documentation in this project (atcontent/docs/platform/sdks/server/typescript.mdx) recommends@novu/api. While @novu/node is a valid package with trigger method signaturenovu.trigger(workflowIdentifier: string, options: {...}), this creates inconsistency within the documentation.Either:
- Update apns.mdx to use
@novu/api(matching the TypeScript SDK docs pattern)- Update the initialization to use object syntax:
new Novu({ secretKey: '<NOVU_SECRET_KEY>' })instead of string parameterThe TypeScript SDK documentation shows the current recommended pattern for Node.js environments.
Summary by CodeRabbit
Release Notes