docs: point non-typedoc references in typedocs to new docs.page paths

invertase · Dec 19, 2024 · e0d7c7a · e0d7c7a
1 parent 330c07f
commit e0d7c7a
Show file tree

Hide file tree

Showing 50 changed files with 181 additions and 181 deletions.
diff --git a/docs/react-native/reference/Enumeration.AlarmType.mdx b/docs/react-native/reference/Enumeration.AlarmType.mdx
@@ -8,7 +8,7 @@
 
 An interface representing the different alarm types which can be used with `TimestampTrigger.alarmManager.type`.
 
-View the [Triggers](/react-native/docs/triggers) documentation to learn more.
+View the [Triggers](/react-native/triggers) documentation to learn more.
 
 ## Enumeration Members
 

diff --git a/docs/react-native/reference/Enumeration.AndroidBadgeIconType.mdx b/docs/react-native/reference/Enumeration.AndroidBadgeIconType.mdx
@@ -8,7 +8,7 @@
 
 Enum used to define how a notification badge is displayed in badge mode.
 
-View the [Badges](/react-native/docs/android/appearance#badges) documentation for more information.
+View the [Badges](/react-native/android/appearance#badges) documentation for more information.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Enumeration.AndroidColor.mdx b/docs/react-native/reference/Enumeration.AndroidColor.mdx
@@ -8,7 +8,7 @@
 
 A set or predefined colors which can be used with Android Notifications.
 
-View the [Color](/react-native/docs/android/appearance#color) documentation to learn more.
+View the [Color](/react-native/android/appearance#color) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Enumeration.AndroidGroupAlertBehavior.mdx b/docs/react-native/reference/Enumeration.AndroidGroupAlertBehavior.mdx
@@ -8,7 +8,7 @@
 
 Enum used to describe how a notification alerts the user when it apart of a group.
 
-View the [Grouping & Sorting](/react-native/docs/android/grouping-and-sorting#group-behaviour) documentation to
+View the [Grouping & Sorting](/react-native/android/grouping-and-sorting#group-behaviour) documentation to
 learn more.
 
 ## Platform

diff --git a/docs/react-native/reference/Enumeration.AndroidImportance.mdx b/docs/react-native/reference/Enumeration.AndroidImportance.mdx
@@ -14,7 +14,7 @@ or directly onto the notification for devices which do not support channels.
 The importance is used to both change the visual prompt of a received notification
 and also how it visually appears on the device.
 
-View the [Android Appearance](/react-native/docs/android/appearance#importance) documentation to learn more.
+View the [Android Appearance](/react-native/android/appearance#importance) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Enumeration.AndroidNotificationSetting.mdx b/docs/react-native/reference/Enumeration.AndroidNotificationSetting.mdx
@@ -11,7 +11,7 @@ An interface representing the current android only notification-related settings
 This interface is returned from [`requestPermission`](/react-native/reference/requestpermission)
 and [`getNotificationSettings`](/react-native/reference/getnotificationsettings).
 
-View the [Permissions](/react-native/docs/android/permissions) documentation to learn more.
+View the [Permissions](/react-native/android/permissions) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Enumeration.AndroidStyle.mdx b/docs/react-native/reference/Enumeration.AndroidStyle.mdx
@@ -8,7 +8,7 @@
 
 Available Android Notification Styles.
 
-View the [Styles](/react-native/docs/android/styles) documentation to learn more with example usage.
+View the [Styles](/react-native/android/styles) documentation to learn more with example usage.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Enumeration.AndroidVisibility.mdx b/docs/react-native/reference/Enumeration.AndroidVisibility.mdx
@@ -10,7 +10,7 @@ Interface used to define the visibility of an Android notification.
 
 Use with the `visibility` property on the notification.
 
-View the [Visibility](/react-native/docs/android/appearance#visibility) documentation to learn more.
+View the [Visibility](/react-native/android/appearance#visibility) documentation to learn more.
 
 Default value is `AndroidVisibility.PRIVATE`.
 

diff --git a/docs/react-native/reference/Enumeration.EventType.mdx b/docs/react-native/reference/Enumeration.EventType.mdx
@@ -8,7 +8,7 @@
 
 An enum representing an event type, defined on [`Event`](/react-native/reference/event).
 
-View the [Events](/react-native/docs/events) documentation to learn more about foreground and
+View the [Events](/react-native/events) documentation to learn more about foreground and
 background events.
 
 ## Enumeration Members

diff --git a/docs/react-native/reference/Enumeration.RepeatFrequency.mdx b/docs/react-native/reference/Enumeration.RepeatFrequency.mdx
@@ -8,7 +8,7 @@
 
 An interface representing the different frequencies which can be used with `TimestampTrigger.repeatFrequency`.
 
-View the [Triggers](/react-native/docs/triggers) documentation to learn more.
+View the [Triggers](/react-native/triggers) documentation to learn more.
 
 ## Enumeration Members
 

diff --git a/docs/react-native/reference/Enumeration.TimeUnit.mdx b/docs/react-native/reference/Enumeration.TimeUnit.mdx
@@ -8,7 +8,7 @@
 
 An interface representing the different units of time which can be used with `IntervalTrigger.timeUnit`.
 
-View the [Triggers](/react-native/docs/triggers) documentation to learn more.
+View the [Triggers](/react-native/triggers) documentation to learn more.
 
 ## Enumeration Members
 

diff --git a/docs/react-native/reference/Enumeration.TriggerType.mdx b/docs/react-native/reference/Enumeration.TriggerType.mdx
@@ -8,7 +8,7 @@
 
 Available Trigger Types.
 
-View the [Triggers](/react-native/docs/triggers) documentation to learn more with example usage.
+View the [Triggers](/react-native/triggers) documentation to learn more with example usage.
 
 ## Enumeration Members
 

diff --git a/docs/react-native/reference/Interface.AndroidAction.mdx b/docs/react-native/reference/Interface.AndroidAction.mdx
@@ -12,7 +12,7 @@ Notification actions allow users to interact with notifications, allowing you to
 within your application. When an action completes (e.g. pressing an action, or filling out an input
 box) an event is sent.
 
-View the [Quick Actions](/react-native/docs/android/interaction#quick-actions) documentation to learn more.
+View the [Quick Actions](/react-native/android/interaction#quick-actions) documentation to learn more.
 
 ## Platform
 
@@ -43,7 +43,7 @@ If provided, the action accepts user input.
 If `true`, the user will be able to provide free text input when the action is pressed. This
 property can be further configured for advanced inputs.
 
-View the [Action Input](/react-native/docs/android/interaction#action-input) documentation to
+View the [Action Input](/react-native/android/interaction#action-input) documentation to
 learn more.
 
 #### Defined in
@@ -60,7 +60,7 @@ The press action interface describing what happens when an action completes.
 
 Note; unlike the `pressAction` in the notification body, an action does not need to open the application
 and can perform background tasks. See the [AndroidPressAction](/react-native/reference/androidpressaction) reference
-or [Quick Actions](/react-native/docs/android/interaction#quick-actions) documentation to learn more.
+or [Quick Actions](/react-native/android/interaction#quick-actions) documentation to learn more.
 
 #### Defined in
 

diff --git a/docs/react-native/reference/Interface.AndroidBigPictureStyle.mdx b/docs/react-native/reference/Interface.AndroidBigPictureStyle.mdx
@@ -10,7 +10,7 @@ The interface used when displaying a Big Picture Style notification.
 
 <Vimeo id="android-style-bigpicture" caption="Android Big Picture Style" />
 
-View the [Big Picture](/react-native/docs/android/styles#big-picture) documentation to learn more.
+View the [Big Picture](/react-native/android/styles#big-picture) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.AndroidBigTextStyle.mdx b/docs/react-native/reference/Interface.AndroidBigTextStyle.mdx
@@ -10,7 +10,7 @@ The interface used when displaying a Big Text Style notification.
 
 <Vimeo id="android-style-bigtext" caption="Android Big Text Style" />
 
-View the [Big Text](/react-native/docs/android/styles#big-text) documentation to learn more.
+View the [Big Text](/react-native/android/styles#big-text) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.AndroidChannel.mdx b/docs/react-native/reference/Interface.AndroidChannel.mdx
@@ -11,7 +11,7 @@ An interface for describing an Android Channel.
 Channels override any individual notification preferences (e.g. lights/vibration) and the user
 has final control over the setting. Once created, only channel metadata can be updated (e.g. name).
 
-View the [Channels & Groups](/react-native/docs/android/channels) documentation to learn more.
+View the [Channels & Groups](/react-native/android/channels) documentation to learn more.
 
 ## Platform
 
@@ -29,7 +29,7 @@ android
 
 Sets whether badges are enabled for the channel.
 
-View the [Badges](/react-native/docs/android/appearance#badges) documentation to learn more.
+View the [Badges](/react-native/android/appearance#badges) documentation to learn more.
 
 Defaults to `true`.
 

diff --git a/docs/react-native/reference/Interface.AndroidChannelGroup.mdx b/docs/react-native/reference/Interface.AndroidChannelGroup.mdx
@@ -11,7 +11,7 @@ An interface for describing an Android Channel Group.
 Channel groups have no impact on the notification, they are used to help group channels in the applications
 settings UI.
 
-View the [Channels & Groups](/react-native/docs/android/channels) documentation to learn more.
+View the [Channels & Groups](/react-native/android/channels) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.AndroidInboxStyle.mdx b/docs/react-native/reference/Interface.AndroidInboxStyle.mdx
@@ -10,7 +10,7 @@ The interface used when displaying a Inbox Style notification.
 
 <Vimeo id="android-style-inbox" caption="Android Inbox Style" />
 
-View the [Inbox](/react-native/docs/android/styles#inbox) documentation to learn more.
+View the [Inbox](/react-native/android/styles#inbox) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.AndroidInput.mdx b/docs/react-native/reference/Interface.AndroidInput.mdx
@@ -8,7 +8,7 @@
 
 The interface used to enable advanced user input on a notification.
 
-View the [Action Input](/react-native/docs/android/interaction#action-input) documentation to learn more.
+View the [Action Input](/react-native/android/interaction#action-input) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.AndroidMessagingStyle.mdx b/docs/react-native/reference/Interface.AndroidMessagingStyle.mdx
@@ -10,7 +10,7 @@ The interface used when displaying a Messaging Style notification.
 
 <Vimeo id="android-style-messaging" caption="Android Messaging Style" />
 
-View the [Messaging](/react-native/docs/android/styles#messaging) documentation to learn more.
+View the [Messaging](/react-native/android/styles#messaging) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.AndroidMessagingStyleMessage.mdx b/docs/react-native/reference/Interface.AndroidMessagingStyleMessage.mdx
@@ -11,7 +11,7 @@ The interface for messages when constructing a Messaging Style notification.
 <Vimeo id="android-style-messaging" caption="Android Messaging Style" />
 
 View the [`AndroidMessagingStyle`](/react-native/reference/androidmessagingstyle) reference
-and [Messaging](/react-native/docs/android/styles#messaging) documentation to learn more.
+and [Messaging](/react-native/android/styles#messaging) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.AndroidNotificationSettings.mdx b/docs/react-native/reference/Interface.AndroidNotificationSettings.mdx
@@ -16,7 +16,7 @@ Enum describing if you can create triggers
 
 For Android \< 12 / API \< 31, this will default to true
 
-View the [Trigger](/react-native/docs/android/triggers#android-12-limitations) documentation for more information.
+View the [Trigger](/react-native/android/triggers#android-12-limitations) documentation for more information.
 
 #### Defined in
 

diff --git a/docs/react-native/reference/Interface.AndroidProgress.mdx b/docs/react-native/reference/Interface.AndroidProgress.mdx
@@ -10,7 +10,7 @@ Interface for defining the progress of an Android Notification.
 
 <Vimeo id="android-progress-summary" caption="Android Progress (w/ Big Picture Style)" />
 
-View the [Progress Indicators](/react-native/docs/android/progress-indicators) documentation to learn more.
+View the [Progress Indicators](/react-native/android/progress-indicators) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.Event.mdx b/docs/react-native/reference/Interface.Event.mdx
@@ -8,7 +8,7 @@
 
 An interface representing a Notifee event.
 
-View the [Events](/react-native/docs/events) documentation to learn more about foreground and
+View the [Events](/react-native/events) documentation to learn more about foreground and
 background events.
 
 ## Properties

diff --git a/docs/react-native/reference/Interface.EventDetail.mdx b/docs/react-native/reference/Interface.EventDetail.mdx
@@ -8,7 +8,7 @@
 
 An interface representing the different detail values which can be provided with a notification event.
 
-View the [Events](/react-native/docs/events) documentation to learn more.
+View the [Events](/react-native/events) documentation to learn more.
 
 ## Properties
 

diff --git a/docs/react-native/reference/Interface.IOSForegroundPresentationOptions.mdx b/docs/react-native/reference/Interface.IOSForegroundPresentationOptions.mdx
@@ -10,7 +10,7 @@ An interface to customise how notifications are shown when the app is in the for
 
 By default, Notifee will show iOS notifications in heads-up mode if your app is currently in the foreground.
 
-View the [Foreground Notifications](/react-native/docs/ios/appearance#foreground-notifications) to learn
+View the [Foreground Notifications](/react-native/ios/appearance#foreground-notifications) to learn
 more.
 
 ## Platform

diff --git a/docs/react-native/reference/Interface.IOSInput.mdx b/docs/react-native/reference/Interface.IOSInput.mdx
@@ -8,7 +8,7 @@
 
 The interface used to enable advanced user input on a notification.
 
-View the [Action input](/react-native/docs/ios/interaction#action-input) documentation to learn more.
+View the [Action input](/react-native/ios/interaction#action-input) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.IOSNotificationAttachment.mdx b/docs/react-native/reference/Interface.IOSNotificationAttachment.mdx
@@ -8,7 +8,7 @@
 
 An interface for describing an iOS Notification Attachment.
 
-View the [Attachments](/react-native/docs/ios/appearance#attachments) documentation to learn more.
+View the [Attachments](/react-native/ios/appearance#attachments) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.IOSNotificationCategory.mdx b/docs/react-native/reference/Interface.IOSNotificationCategory.mdx
@@ -10,7 +10,7 @@ A interface representing a notification category created via [`setNotificationCa
 
 At minimum, a category must be created with a unique identifier, all other properties are optional.
 
-View the [Categories](/react-native/docs/ios/categories) documentation to learn more.
+View the [Categories](/react-native/ios/categories) documentation to learn more.
 
 ## Platform
 
@@ -110,7 +110,7 @@ The unique ID for the category.
 
 Specify a custom format for the summary text, which is visible when notifications are grouped together.
 
-View the [Summary Text](/react-native/docs/ios/categories#category-summary-text) documentation to learn more.
+View the [Summary Text](/react-native/ios/categories#category-summary-text) documentation to learn more.
 
 #### Defined in
 

diff --git a/docs/react-native/reference/Interface.IOSNotificationCategoryAction.mdx b/docs/react-native/reference/Interface.IOSNotificationCategoryAction.mdx
@@ -12,7 +12,7 @@ Quick actions allow users to interact with notifications, allowing you to handle
 within your application. When an action completes (e.g. pressing an action, or filling out an input
 box) an event is sent.
 
-View the [Quick Actions](/react-native/docs/ios/interaction#quick-actions) documentation to learn more.
+View the [Quick Actions](/react-native/ios/interaction#quick-actions) documentation to learn more.
 
 ## Platform
 
@@ -77,7 +77,7 @@ If `true`, the user will be able to provide free text input when the action is p
 The placeholder and button text can be customized by providing an object
 of type [`IOSInput`](/react-native/reference/iosinput).
 
-View the [Action Input](/react-native/docs/ios/interaction#action-input) documentation to
+View the [Action Input](/react-native/ios/interaction#action-input) documentation to
 learn more.
 
 #### Defined in

diff --git a/docs/react-native/reference/Interface.IOSNotificationPermissions.mdx b/docs/react-native/reference/Interface.IOSNotificationPermissions.mdx
@@ -9,7 +9,7 @@
 An interface representing all the available permissions that can be requested by your app via
 the [`requestPermission`](/react-native/reference/requestpermission) API.
 
-View the [Permissions](/react-native/docs/ios/permissions) to learn
+View the [Permissions](/react-native/ios/permissions) to learn
 more.
 
 ## Platform
@@ -84,7 +84,7 @@ Defaults to true.
 
 Request permission to display critical notifications.
 
-View the [Critical Notifications](/react-native/docs/ios/behaviour#critical-notifications) documentation for more information
+View the [Critical Notifications](/react-native/ios/behaviour#critical-notifications) documentation for more information
 and usage examples.
 
 Defaults to false.

diff --git a/docs/react-native/reference/Interface.IOSNotificationSettings.mdx b/docs/react-native/reference/Interface.IOSNotificationSettings.mdx
@@ -11,7 +11,7 @@ An interface representing the current authorization status and notification-rela
 This interface is returned from [`requestPermission`](/react-native/reference/requestpermission)
 and [`getNotificationSettings`](/react-native/reference/getnotificationsettings).
 
-View the [Observing Settings](/react-native/docs/ios/permissions#observing-settings) documentation to learn more.
+View the [Observing Settings](/react-native/ios/permissions#observing-settings) documentation to learn more.
 
 ## Platform
 

diff --git a/docs/react-native/reference/Interface.InitialNotification.mdx b/docs/react-native/reference/Interface.InitialNotification.mdx
@@ -8,7 +8,7 @@
 
 An interface representing a notification & action that launched the current app / or Android activity.
 
-View the [App open events](/react-native/docs/events#app-open-events) documentation to learn more.
+View the [App open events](/react-native/events#app-open-events) documentation to learn more.
 
 This interface is returned from [`getInitialNotification`](/react-native/reference/getinitialnotification) when
 an initial notification is available.

diff --git a/docs/react-native/reference/Interface.IntervalTrigger.mdx b/docs/react-native/reference/Interface.IntervalTrigger.mdx
@@ -8,7 +8,7 @@
 
 Interface for building a trigger that repeats at a specified interval.
 
-View the [Triggers](/react-native/docs/triggers) documentation to learn more.
+View the [Triggers](/react-native/triggers) documentation to learn more.
 
 ## Properties
 

diff --git a/docs/react-native/reference/Interface.NativeAndroidChannel.mdx b/docs/react-native/reference/Interface.NativeAndroidChannel.mdx
@@ -26,7 +26,7 @@ android
 
 Sets whether badges are enabled for the channel.
 
-View the [Badges](/react-native/docs/android/appearance#badges) documentation to learn more.
+View the [Badges](/react-native/android/appearance#badges) documentation to learn more.
 
 Defaults to `true`.
 

diff --git a/docs/react-native/reference/Interface.NativeAndroidChannelGroup.mdx b/docs/react-native/reference/Interface.NativeAndroidChannelGroup.mdx
@@ -29,7 +29,7 @@ blocked by the user.
 
 On API levels \< 28, returns `false`.
 
-View the [Listening to channel events](/react-native/docs/android/channels#listening-to-channel-events)
+View the [Listening to channel events](/react-native/android/channels#listening-to-channel-events)
 documentation to learn more about subscribing to when a channel is blocked by the user.
 
 #### Platform

diff --git a/docs/react-native/reference/Interface.Notification.mdx b/docs/react-native/reference/Interface.Notification.mdx
@@ -8,7 +8,7 @@
 
 Interface for building a local notification for both Android & iOS devices.
 
-To learn more about displaying a notification, view the [Displaying a Notification](/react-native/docs/displaying-a-notification)
+To learn more about displaying a notification, view the [Displaying a Notification](/react-native/displaying-a-notification)
 documentation.
 
 ## Properties