Use Absolute Paths

notificationapi-com · Oct 3, 2024 · 9e350a5 · 9e350a5
1 parent 57a6bad
commit 9e350a5
Show file tree

Hide file tree

Showing 18 changed files with 68 additions and 68 deletions.
diff --git a/docs/channels/email.md b/docs/channels/email.md
@@ -23,12 +23,12 @@ You DON'T need another 3rd-party email service like SendGrid or SES. Through our
 
 ## Important Features
 
-- High delivery through SPF, DKIM and DMARC - [see docs](../guides/domain-verification.md)
+- High delivery through SPF, DKIM and DMARC - [see docs](/guides/domain-verification.md)
 - Compliant with Google's and Yahoo's email sender policies and best practices for high deliverability - [see docs](email.md#Google and Yahoo Bulk Sender Requirements)
-- Merge tags (injecting dynamic values into the email content) - [see docs](../features/mergetags)
-- Pre-built Unsubscribe Link and Web Page - [see docs](../components/unsubscribe-page)
-- Attachments - [see docs](../reference/server#send)
-- CC, BCC fields - [see docs](../reference/server#send)
+- Merge tags (injecting dynamic values into the email content) - [see docs](/features/mergetags)
+- Pre-built Unsubscribe Link and Web Page - [see docs](/components/unsubscribe-page)
+- Attachments - [see docs](/reference/server#send)
+- CC, BCC fields - [see docs](/reference/server#send)
 
 ## Email Editor
 

diff --git a/docs/channels/inapp.md b/docs/channels/inapp.md
@@ -23,7 +23,7 @@ Any JavaScript based front-end framework, including:
 
 ## Requirements
 
-- Implementing our in-app notifications widget in your front-end. [See step-by-step guide here.](../quick-start/display-inapp-notifications)
+- Implementing our in-app notifications widget in your front-end. [See step-by-step guide here.](/quick-start/display-inapp-notifications)
 
 :::tip
 You don't need any database or other APIs. We manage all the necessary storage and APIs under-the-hood. Our widget automatically connects to our servers and gets the job done.
@@ -35,9 +35,9 @@ The widget is open-source and fully customizable. You can modify the look and fe
 
 - Fully customizable look and feel through CSS
 - Live updates (new notifications appear without refreshing the page)
-- Popup vs. Page modes - [see docs](../reference/js-client#showinapp)
-- Multiple Mark as read modes - [see docs](../reference/js-client#showinapp)
-- Pagination or endless scrolling - [see docs](../reference/js-client#showinapp)
+- Popup vs. Page modes - [see docs](/reference/js-client#showinapp)
+- Multiple Mark as read modes - [see docs](/reference/js-client#showinapp)
+- Pagination or endless scrolling - [see docs](/reference/js-client#showinapp)
 
 ## Tracking Options
 

diff --git a/docs/channels/mobile-push.md b/docs/channels/mobile-push.md
@@ -6,8 +6,8 @@ Mobile Push is a channel that allows you to send push notifications to your user
 
 ## Requirements
 
-- Setting up [Apple Push Notification Service] or Firebase Cloud Messaging (FCM) 👉 [step-by-step guide](../guides/mobile-push)
-- Integrating our easy-to-use [iOS SDK](../reference/ios-sdk) or [Android SDK](../reference/android-sdk) into your apps
+- Setting up [Apple Push Notification Service] or Firebase Cloud Messaging (FCM) 👉 [step-by-step guide](/guides/mobile-push)
+- Integrating our easy-to-use [iOS SDK](/reference/ios-sdk) or [Android SDK](/reference/android-sdk) into your apps
 
 :::note
 Mobile push notification is the only channel in NotificationAPI that relies on external 3rd-parties (Apple and FCM). This is due to a limitation of the mobile operating systems.

diff --git a/docs/components/inapp.md b/docs/components/inapp.md
@@ -6,8 +6,8 @@ This widget is part of our Front-end SDK which is written in Vanilla JavaScript,
 
 Relevant docs:
 
-- [Add the widget to your front-end](../quick-start/display-inapp-notifications)
-- [Front-end SDK reference](../reference/js-client.md)
+- [Add the widget to your front-end](/quick-start/display-inapp-notifications)
+- [Front-end SDK reference](/reference/js-client.md)
 
 ## How It Works
 

diff --git a/docs/components/user-preferences.md b/docs/components/user-preferences.md
@@ -10,8 +10,8 @@ This widget is part of our Front-end SDK, compatible with any JavaScript-based f
 
 Relevant docs:
 
-- [Add the widget to your front-end](../quick-start/manage-preferences)
-- [Front-end SDK reference](../reference/js-client)
+- [Add the widget to your front-end](/quick-start/manage-preferences)
+- [Front-end SDK reference](/reference/js-client)
 
 ## How It Works
 

diff --git a/docs/features/digest.md b/docs/features/digest.md
@@ -29,7 +29,7 @@ style={{
 
 In the example above, we are allowing users to receive emails intantly (no batching) or to unsubscribe from this email. The default delivery method for new users is based on the small green tag, which you can change.
 
-The above options also allow users to see and pick the right preference for themselves using our [prebuilt user preference component](../components/user-preferences.md):
+The above options also allow users to see and pick the right preference for themselves using our [prebuilt user preference component](/components/user-preferences.md):
 
 import userPreference from '@site/static/UserPreferencesEmailBatching.png';
 
@@ -136,7 +136,7 @@ For example, assume a notification is configured to send batches `Weekly` on `Mo
 
 ### Does `Batch & Digest` user's timezone?
 
-Yes, if the user's timezone is defined by [the front end SDKs](../reference/js-client#identify), and/or [backend SDKs](../reference/server#identifyuser) or simply added to the [send request](../reference/server#send) the request is scheduled for the user's timezone. The default timezone is `EST`.
+Yes, if the user's timezone is defined by [the front end SDKs](/reference/js-client#identify), and/or [backend SDKs](/reference/server#identifyuser) or simply added to the [send request](/reference/server#send) the request is scheduled for the user's timezone. The default timezone is `EST`.
 
 ### What happens to email attachments?
 

diff --git a/docs/features/logs.md b/docs/features/logs.md
@@ -8,7 +8,7 @@ import logs from '@site/static/Logs.png';
 
 :::note
 
-To programmatically access the log of your requests, you can use the [queryLogs](../reference/server#querylogs) method.
+To programmatically access the log of your requests, you can use the [queryLogs](/reference/server#querylogs) method.
 
 :::
 
@@ -58,7 +58,7 @@ Call Specific Sub-Events:
 
 Besides the predefined filters on the logs table, you can use any custom queries to dig deep. For example: `$.request.mergeTags.firstName="Jane"`
 
-You can search for anything in the `$.request`, which contains the [original parameters you passed to send()](../reference/server.md#send). Here's an example of a `$.request` object:
+You can search for anything in the `$.request`, which contains the [original parameters you passed to send()](/reference/server.md#send). Here's an example of a `$.request` object:
 
 ```js title="$.request"
 {

diff --git a/docs/features/scheduling.md b/docs/features/scheduling.md
@@ -18,7 +18,7 @@ Scheduling a notification works just like sending a regular notification through
 
 ## How does it work?
 
-Simply specify the `schedule` parameter when using the [`send` function](../reference/server#send):
+Simply specify the `schedule` parameter when using the [`send` function](/reference/server#send):
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
@@ -167,7 +167,7 @@ notificationapi.send({
 </TabItem>
 </Tabs>
 
-You have the option to [update](../reference/server.md#updateschedule) or [delete](../reference/server.md#deleteschedule) the schedule before it is sent.
+You have the option to [update](/reference/server.md#updateschedule) or [delete](/reference/server.md#deleteschedule) the schedule before it is sent.
 
 ## Frequently Asked Questions (FAQ)
 
@@ -177,7 +177,7 @@ Yes, you can update the request after sending it by using the `trackingId` befor
 
 ### Can I cancel a scheduled notification?
 
-Yes, with the `trackingId`, you can cancel a scheduled notification before it is sent. If the notification has already been sent, you can retract in-app notifications using the [retract function](../reference/server.md#retract).
+Yes, with the `trackingId`, you can cancel a scheduled notification before it is sent. If the notification has already been sent, you can retract in-app notifications using the [retract function](/reference/server.md#retract).
 
 ### How is error checking and logical operations handled with scheduled notifications?
 

diff --git a/docs/features/subnotifications.md b/docs/features/subnotifications.md
@@ -27,6 +27,6 @@ notificationapi.send({
 
 ### 2. User Preferences
 
-If you are using our API/SDK to explicitly set user preferences, you can specify the `subNotificationId` parameter in the `setUserPreferences` function. See [reference](../reference/js-client#patchuserpreference).
+If you are using our API/SDK to explicitly set user preferences, you can specify the `subNotificationId` parameter in the `setUserPreferences` function. See [reference](/reference/js-client#patchuserpreference).
 
 If you are using our user preferences widget, sub-toggles will automatically appear for the subNotifications so users can opt in or out of them.
diff --git a/docs/guides/mobile-push.md b/docs/guides/mobile-push.md
@@ -28,9 +28,9 @@ To send a push notification to your mobile app on an Apple device, we need some
 
 NotificationAPI Mobile SDKs automatically manage and sync APNs tokens with NotificationAPI servers, so you don't have to. This allows you to send push notifications directly to a user from your back-end, rather than worrying about generating, storing and retrieving the APNs token.
 
-| Mobile SDK                  | APNs Token Management |
-| :-------------------------- | :-------------------: |
-| [iOS](../reference/ios-sdk) |       Automatic       |
+| Mobile SDK                | APNs Token Management |
+| :------------------------ | :-------------------: |
+| [iOS](/reference/ios-sdk) |       Automatic       |
 
 ## Firebase Cloud Messaging (FCM)
 
@@ -52,10 +52,10 @@ To send a push notification to your mobile app on an Android device, we need som
 
 NotificationAPI Mobile SDKs automatically manage and sync FCM tokens with NotificationAPI servers, so you don't have to. This allows you to send push notifications directly to a userId from your back-end, rather than worrying about generating, storing and retrieving the FCM token.
 
-| Mobile SDK                          | APNs Token Management |
-| :---------------------------------- | :-------------------: |
-| [Android](../reference/android-sdk) |       Automatic       |
+| Mobile SDK                        | APNs Token Management |
+| :-------------------------------- | :-------------------: |
+| [Android](/reference/android-sdk) |       Automatic       |
 
 ## Sending Customized Messages
 
-To further customize your push notification please check out the `options.apn` attribute in the [`send`](../reference/server.md#send) request.
+To further customize your push notification please check out the `options.apn` attribute in the [`send`](/reference/server.md#send) request.
diff --git a/docs/guides/web-push.md b/docs/guides/web-push.md
@@ -102,7 +102,7 @@ const notificationapi = new NotificationAPI({
 
 <sup>\*</sup> Required parameters
 
-For more information please checkout our [vanilla JS SDK](../reference/js-client#setup--initialization) guid.
+For more information please checkout our [vanilla JS SDK](/reference/js-client#setup--initialization) guid.
 
 **Step 3: Service Worker Setup**
 
@@ -143,7 +143,7 @@ notificationapi.askForWebPushPermission();
 With the frontend set up to receive notifications, you can now send them from your backend.
 
 - **Integrate the Backend SDK**: Use NotificationAPI's Backend SDKs to send notifications programmatically.
-- **[Send a Notification](../quick-start/send-a-notification)**: Follow the guide to start sending notifications.
+- **[Send a Notification](/quick-start/send-a-notification)**: Follow the guide to start sending notifications.
 
 ---
 

diff --git a/docs/quick-start/display-inapp-notifications.md b/docs/quick-start/display-inapp-notifications.md
@@ -23,7 +23,7 @@ import InAppPNG from '@site/static/inapp.png';
 
 ## Playground
 
-[You can see and modify the code here on our in-app playground](../features/mergetags#playground).
+[You can see and modify the code here on our in-app playground](/features/mergetags#playground).
 
 ## Step 1: Install the Front-End SDK
 
@@ -267,6 +267,6 @@ You are now receiving in-app notifications on your front-end! 🎉
 
 Let's do a few more things:
 
-- [⚙️ Manage User Notification Preferences](../quick-start/manage-preferences)
-- [📱 Setup Mobile Push](../guides/mobile-push)
-- [🌐 Setup Web Push](../guides/web-push)
+- [⚙️ Manage User Notification Preferences](/quick-start/manage-preferences)
+- [📱 Setup Mobile Push](/guides/mobile-push)
+- [🌐 Setup Web Push](/guides/web-push)
diff --git a/docs/quick-start/manage-preferences.md b/docs/quick-start/manage-preferences.md
@@ -43,15 +43,15 @@ notificationapi.showUserPreferences();
 
 You can set the user preferences programmatically from both your back-end and front-end code:
 
-- [Front-end reference](../reference/js-client#patchuserpreference)
-- [Back-end reference](../reference/server#setuserpreferences)
+- [Front-end reference](/reference/js-client#patchuserpreference)
+- [Back-end reference](/reference/server#setuserpreferences)
 
 ## Next Steps
 
 So now you have taken care of the user preferences. 🎉
 
 Here's what may interest you:
 
-- [🙉 No-Code Unsubscribe Page](../components/unsubscribe-page)
-- [🎨 Styling the In-App Widget](../components/inapp#styling-and-branding)
-- [🌈 Styling the Preferences Widget](../components/user-preferences#styling-and-branding)
+- [🙉 No-Code Unsubscribe Page](/components/unsubscribe-page)
+- [🎨 Styling the In-App Widget](/components/inapp#styling-and-branding)
+- [🌈 Styling the Preferences Widget](/components/user-preferences#styling-and-branding)
diff --git a/docs/quick-start/send-a-notification.md b/docs/quick-start/send-a-notification.md
@@ -452,7 +452,7 @@ You are now successfully sending notifications to any channel you wish. 🎉
 
 Let's do a few more things:
 
-- [🔔 Display In-App Notifications](../quick-start/display-inapp-notifications)
-- [⚙️ Manage User Notification Preferences](../quick-start/manage-preferences)
-- [📱 Setup Mobile Push](../guides/mobile-push)
-- [🌐 Setup Web Push](../guides/web-push)
+- [🔔 Display In-App Notifications](/quick-start/display-inapp-notifications)
+- [⚙️ Manage User Notification Preferences](/quick-start/manage-preferences)
+- [📱 Setup Mobile Push](/guides/mobile-push)
+- [🌐 Setup Web Push](/guides/web-push)
diff --git a/docs/reference/js-client.md b/docs/reference/js-client.md
@@ -368,13 +368,13 @@ notificationapi.patchUserPreference('order_tracking', 'EMAIL', false);
 | notificationId\*  | string  | The ID of the notification in NotificationAPI.                                                                                                                                                                   |
 | channel\*         | string  | The channel for which you wish to change the setting. Accepted values: <br/>`EMAIL`, `INAPP_WEB`, `SMS`, `CALL`, `PUSH`, `WEB_PUSH`                                                                              |
 | state\*           | boolean | The preference of the user. If set to false, the user will no longer receive the specified notification on the specified channel, until the state is set to true again through the API or the preferences popup. |
-| subNotificationId | string  | Only when using [subNotificationIds](../features/subnotifications)                                                                                                                                               |
+| subNotificationId | string  | Only when using [subNotificationIds](/features/subnotifications)                                                                                                                                                 |
 
 ## showInApp
 
 This function renders the in-app notifications widget on your front-end.
 
-Complete guide: [In-App Notifications Widget](../components/inapp)
+Complete guide: [In-App Notifications Widget](/components/inapp)
 
 ```js
 notificationapi.showInApp({
@@ -397,7 +397,7 @@ notificationapi.showInApp({
 
 This function renders the user preferences widget on your front-end.
 
-Complete guide: [User Preferences Widget](../components/user-preferences)
+Complete guide: [User Preferences Widget](/components/user-preferences)
 
 ```js
 notificationapi.showUserPreferences();

diff --git a/docs/reference/js-core.md b/docs/reference/js-core.md
@@ -47,7 +47,7 @@ const client = NotificationAPIClientSDK.init({
 
 #### Secure Mode
 
-If you are using the [secure mode](../guides/secure-mode), you must provide the `hashedUserId` to the init function.
+If you are using the [secure mode](/guides/secure-mode), you must provide the `hashedUserId` to the init function.
 
 ## API Wrapper