From 939ce3ada27ca5bb4ff71368fdfb334e5bc778f1 Mon Sep 17 00:00:00 2001 From: Dan Siegel Date: Thu, 24 Oct 2024 19:59:31 -0600 Subject: [PATCH] docs: update essentials scaffolding --- .../{ => applicationmodel}/appcontext.md | 2 +- .../essentials/applicationmodel/browser.md | 5 ++++ .../applicationmodel/communication/email.md | 5 ++++ .../communication}/phonedialer.md | 2 +- .../applicationmodel/communication/toc.yml | 4 ++++ .../datatransfer/clipboard.md | 5 ++++ .../applicationmodel/datatransfer/toc.yml | 2 ++ .../{ => applicationmodel}/latestversion.md | 2 +- .../essentials/applicationmodel/launcher.md | 5 ++++ .../essentials/applicationmodel/toc.yml | 14 +++++++++++ .../applicationmodel/versiontracking.md | 5 ++++ docs/plugins/essentials/battery.md | 5 ---- docs/plugins/essentials/devices/battery.md | 5 ++++ docs/plugins/essentials/devices/deviceinfo.md | 5 ++++ .../essentials/devices/sensors/biometrics.md | 5 ++++ .../essentials/devices/sensors/geocoding.md | 5 ++++ .../essentials/devices/sensors/geofencing.md | 5 ++++ .../essentials/devices/sensors/geolocation.md | 5 ++++ .../essentials/devices/sensors/toc.yml | 8 +++++++ docs/plugins/essentials/devices/toc.yml | 4 ++++ .../plugins/essentials/{ => io}/filesystem.md | 0 docs/plugins/essentials/{ => io}/stores.md | 0 docs/plugins/essentials/io/toc.yml | 4 ++++ .../{ => networking}/connectivity.md | 2 +- docs/plugins/essentials/networking/toc.yml | 2 ++ .../plugins/essentials/notifications/index.md | 6 ++--- .../essentials/notifications/prompts.md | 2 +- .../essentials/{ => threading}/mainthread.md | 2 +- docs/plugins/essentials/threading/toc.yml | 2 ++ docs/plugins/essentials/toc.yml | 24 ++++++++----------- docs/plugins/logging/raygun.md | 2 +- 31 files changed, 115 insertions(+), 29 deletions(-) rename docs/plugins/essentials/{ => applicationmodel}/appcontext.md (96%) create mode 100644 docs/plugins/essentials/applicationmodel/browser.md create mode 100644 docs/plugins/essentials/applicationmodel/communication/email.md rename docs/plugins/essentials/{ => applicationmodel/communication}/phonedialer.md (86%) create mode 100644 docs/plugins/essentials/applicationmodel/communication/toc.yml create mode 100644 docs/plugins/essentials/applicationmodel/datatransfer/clipboard.md create mode 100644 docs/plugins/essentials/applicationmodel/datatransfer/toc.yml rename docs/plugins/essentials/{ => applicationmodel}/latestversion.md (93%) create mode 100644 docs/plugins/essentials/applicationmodel/launcher.md create mode 100644 docs/plugins/essentials/applicationmodel/toc.yml create mode 100644 docs/plugins/essentials/applicationmodel/versiontracking.md delete mode 100644 docs/plugins/essentials/battery.md create mode 100644 docs/plugins/essentials/devices/battery.md create mode 100644 docs/plugins/essentials/devices/deviceinfo.md create mode 100644 docs/plugins/essentials/devices/sensors/biometrics.md create mode 100644 docs/plugins/essentials/devices/sensors/geocoding.md create mode 100644 docs/plugins/essentials/devices/sensors/geofencing.md create mode 100644 docs/plugins/essentials/devices/sensors/geolocation.md create mode 100644 docs/plugins/essentials/devices/sensors/toc.yml create mode 100644 docs/plugins/essentials/devices/toc.yml rename docs/plugins/essentials/{ => io}/filesystem.md (100%) rename docs/plugins/essentials/{ => io}/stores.md (100%) create mode 100644 docs/plugins/essentials/io/toc.yml rename docs/plugins/essentials/{ => networking}/connectivity.md (82%) create mode 100644 docs/plugins/essentials/networking/toc.yml rename docs/plugins/essentials/{ => threading}/mainthread.md (97%) create mode 100644 docs/plugins/essentials/threading/toc.yml diff --git a/docs/plugins/essentials/appcontext.md b/docs/plugins/essentials/applicationmodel/appcontext.md similarity index 96% rename from docs/plugins/essentials/appcontext.md rename to docs/plugins/essentials/applicationmodel/appcontext.md index 3a9014d..6b7cfd5 100644 --- a/docs/plugins/essentials/appcontext.md +++ b/docs/plugins/essentials/applicationmodel/appcontext.md @@ -1,5 +1,5 @@ --- -uid: Plugins.Essentials.AppContext +uid: Plugins.Essentials.ApplicationModel.AppContext --- # AppContext diff --git a/docs/plugins/essentials/applicationmodel/browser.md b/docs/plugins/essentials/applicationmodel/browser.md new file mode 100644 index 0000000..fdbc0a9 --- /dev/null +++ b/docs/plugins/essentials/applicationmodel/browser.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.ApplicationModel.Browser +--- + +# Browser diff --git a/docs/plugins/essentials/applicationmodel/communication/email.md b/docs/plugins/essentials/applicationmodel/communication/email.md new file mode 100644 index 0000000..8f61f16 --- /dev/null +++ b/docs/plugins/essentials/applicationmodel/communication/email.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.ApplicationModel.Communication.Email +--- + +# Email diff --git a/docs/plugins/essentials/phonedialer.md b/docs/plugins/essentials/applicationmodel/communication/phonedialer.md similarity index 86% rename from docs/plugins/essentials/phonedialer.md rename to docs/plugins/essentials/applicationmodel/communication/phonedialer.md index 5220d87..80389fc 100644 --- a/docs/plugins/essentials/phonedialer.md +++ b/docs/plugins/essentials/applicationmodel/communication/phonedialer.md @@ -1,5 +1,5 @@ --- -uid: Plugins.Essentials.PhoneDialer +uid: Plugins.Essentials.ApplicationModel.Communication.PhoneDialer --- # Phone Dialer diff --git a/docs/plugins/essentials/applicationmodel/communication/toc.yml b/docs/plugins/essentials/applicationmodel/communication/toc.yml new file mode 100644 index 0000000..f63ef65 --- /dev/null +++ b/docs/plugins/essentials/applicationmodel/communication/toc.yml @@ -0,0 +1,4 @@ +- name: Email + href: email.md +- name: Phone Dialer + href: phonedialer.md \ No newline at end of file diff --git a/docs/plugins/essentials/applicationmodel/datatransfer/clipboard.md b/docs/plugins/essentials/applicationmodel/datatransfer/clipboard.md new file mode 100644 index 0000000..11ff15f --- /dev/null +++ b/docs/plugins/essentials/applicationmodel/datatransfer/clipboard.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.ApplicationModel.DataTransfer.Clipboard +--- + +# Clipboard diff --git a/docs/plugins/essentials/applicationmodel/datatransfer/toc.yml b/docs/plugins/essentials/applicationmodel/datatransfer/toc.yml new file mode 100644 index 0000000..a3b8eaa --- /dev/null +++ b/docs/plugins/essentials/applicationmodel/datatransfer/toc.yml @@ -0,0 +1,2 @@ +- name: Clipboard + href: clipboard.md \ No newline at end of file diff --git a/docs/plugins/essentials/latestversion.md b/docs/plugins/essentials/applicationmodel/latestversion.md similarity index 93% rename from docs/plugins/essentials/latestversion.md rename to docs/plugins/essentials/applicationmodel/latestversion.md index 3f7b4f6..1863182 100644 --- a/docs/plugins/essentials/latestversion.md +++ b/docs/plugins/essentials/applicationmodel/latestversion.md @@ -1,5 +1,5 @@ --- -uid: Plugins.Essentials.LatestVersion +uid: Plugins.Essentials.ApplicationModel.LatestVersion --- # Latest Version diff --git a/docs/plugins/essentials/applicationmodel/launcher.md b/docs/plugins/essentials/applicationmodel/launcher.md new file mode 100644 index 0000000..0f7b679 --- /dev/null +++ b/docs/plugins/essentials/applicationmodel/launcher.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.ApplicationModel.Launcher +--- + +# Launcher diff --git a/docs/plugins/essentials/applicationmodel/toc.yml b/docs/plugins/essentials/applicationmodel/toc.yml new file mode 100644 index 0000000..e284132 --- /dev/null +++ b/docs/plugins/essentials/applicationmodel/toc.yml @@ -0,0 +1,14 @@ +- name: App Context + href: appcontext.md +- name: Browser + href: browser.md +- name: Communication + href: communication/toc.yml +- name: Data Transfer + href: datatransfer/toc.yml +- name: LatestVersion + href: latestversion.md +- name: Launcher + href: launcher.md +- name: Version Tracking + href: versiontracking.md \ No newline at end of file diff --git a/docs/plugins/essentials/applicationmodel/versiontracking.md b/docs/plugins/essentials/applicationmodel/versiontracking.md new file mode 100644 index 0000000..3deb153 --- /dev/null +++ b/docs/plugins/essentials/applicationmodel/versiontracking.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.ApplicationModel.VersionTracking +--- + +# Version Tracking diff --git a/docs/plugins/essentials/battery.md b/docs/plugins/essentials/battery.md deleted file mode 100644 index c72fc07..0000000 --- a/docs/plugins/essentials/battery.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -uid: Plugins.Essentials.Battery ---- - -# Battery diff --git a/docs/plugins/essentials/devices/battery.md b/docs/plugins/essentials/devices/battery.md new file mode 100644 index 0000000..1c4c6ce --- /dev/null +++ b/docs/plugins/essentials/devices/battery.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.Devices.Battery +--- + +# Battery diff --git a/docs/plugins/essentials/devices/deviceinfo.md b/docs/plugins/essentials/devices/deviceinfo.md new file mode 100644 index 0000000..2b8f27f --- /dev/null +++ b/docs/plugins/essentials/devices/deviceinfo.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.Devices.DeviceInfo +--- + +# DeviceInfo diff --git a/docs/plugins/essentials/devices/sensors/biometrics.md b/docs/plugins/essentials/devices/sensors/biometrics.md new file mode 100644 index 0000000..528f7f4 --- /dev/null +++ b/docs/plugins/essentials/devices/sensors/biometrics.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.Devices.Sensors.Biometrics +--- + +# Biometrics diff --git a/docs/plugins/essentials/devices/sensors/geocoding.md b/docs/plugins/essentials/devices/sensors/geocoding.md new file mode 100644 index 0000000..066831d --- /dev/null +++ b/docs/plugins/essentials/devices/sensors/geocoding.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.Devices.Sensors.Geocoding +--- + +# Geocoding diff --git a/docs/plugins/essentials/devices/sensors/geofencing.md b/docs/plugins/essentials/devices/sensors/geofencing.md new file mode 100644 index 0000000..c526706 --- /dev/null +++ b/docs/plugins/essentials/devices/sensors/geofencing.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.Devices.Sensors.Geofencing +--- + +# Geofencing diff --git a/docs/plugins/essentials/devices/sensors/geolocation.md b/docs/plugins/essentials/devices/sensors/geolocation.md new file mode 100644 index 0000000..effa65e --- /dev/null +++ b/docs/plugins/essentials/devices/sensors/geolocation.md @@ -0,0 +1,5 @@ +--- +uid: Plugins.Essentials.Devices.Senors.Geolocation +--- + +# Geolocation diff --git a/docs/plugins/essentials/devices/sensors/toc.yml b/docs/plugins/essentials/devices/sensors/toc.yml new file mode 100644 index 0000000..58c7766 --- /dev/null +++ b/docs/plugins/essentials/devices/sensors/toc.yml @@ -0,0 +1,8 @@ +- name: Biometrics + href: biometrics.md +- name: Geocoding + href: geocoding.md +- name: Geofencing + href: geofencing.md +- name: Geolocation + href: geolocation.md \ No newline at end of file diff --git a/docs/plugins/essentials/devices/toc.yml b/docs/plugins/essentials/devices/toc.yml new file mode 100644 index 0000000..618f719 --- /dev/null +++ b/docs/plugins/essentials/devices/toc.yml @@ -0,0 +1,4 @@ +- name: Battery + href: battery.md +- name: Sensors + href: sensors/toc.yml \ No newline at end of file diff --git a/docs/plugins/essentials/filesystem.md b/docs/plugins/essentials/io/filesystem.md similarity index 100% rename from docs/plugins/essentials/filesystem.md rename to docs/plugins/essentials/io/filesystem.md diff --git a/docs/plugins/essentials/stores.md b/docs/plugins/essentials/io/stores.md similarity index 100% rename from docs/plugins/essentials/stores.md rename to docs/plugins/essentials/io/stores.md diff --git a/docs/plugins/essentials/io/toc.yml b/docs/plugins/essentials/io/toc.yml new file mode 100644 index 0000000..c931e41 --- /dev/null +++ b/docs/plugins/essentials/io/toc.yml @@ -0,0 +1,4 @@ +- name: File System + href: filesystem.md +- name: Stores + href: stores.md \ No newline at end of file diff --git a/docs/plugins/essentials/connectivity.md b/docs/plugins/essentials/networking/connectivity.md similarity index 82% rename from docs/plugins/essentials/connectivity.md rename to docs/plugins/essentials/networking/connectivity.md index 6b88311..4298a80 100644 --- a/docs/plugins/essentials/connectivity.md +++ b/docs/plugins/essentials/networking/connectivity.md @@ -1,5 +1,5 @@ --- -uid: Plugins.Essentials.Connectivity +uid: Plugins.Essentials.Networking.Connectivity --- # Connectivity diff --git a/docs/plugins/essentials/networking/toc.yml b/docs/plugins/essentials/networking/toc.yml new file mode 100644 index 0000000..a631b85 --- /dev/null +++ b/docs/plugins/essentials/networking/toc.yml @@ -0,0 +1,2 @@ +- name: Connectivity + href: connectivity.md \ No newline at end of file diff --git a/docs/plugins/essentials/notifications/index.md b/docs/plugins/essentials/notifications/index.md index 8075dbc..607a311 100644 --- a/docs/plugins/essentials/notifications/index.md +++ b/docs/plugins/essentials/notifications/index.md @@ -16,9 +16,9 @@ public class MyViewModel(INotifications notifications) ## Next Steps -- [ActionSheets](xref:Prism.Essentials.Notifications.ActionSheets) -- [Alerts](xref:Prism.Essentials.Notifications.Alerts) -- [Prompts](xref:Prism.Essentials.Notifications.Prompts) +- [ActionSheets](xref:Plugins.Essentials.Notifications.ActionSheets) +- [Alerts](xref:Plugins.Essentials.Notifications.Alerts) +- [Prompts](xref:Plugins.Essentials.Notifications.Prompts) > [!NOTE] > This is currently only supported on Android, iOS, MacCatalyst, & WinUI for .NET MAUI and Uno Platform. This feature is planned for future expansion to all Uno Platform platforms and WPF. diff --git a/docs/plugins/essentials/notifications/prompts.md b/docs/plugins/essentials/notifications/prompts.md index 4a4668a..02ade9b 100644 --- a/docs/plugins/essentials/notifications/prompts.md +++ b/docs/plugins/essentials/notifications/prompts.md @@ -1,5 +1,5 @@ --- -uid: Plugins.Essentials.Notifications.ActionSheets +uid: Plugins.Essentials.Notifications.Prompts --- # Prompts diff --git a/docs/plugins/essentials/mainthread.md b/docs/plugins/essentials/threading/mainthread.md similarity index 97% rename from docs/plugins/essentials/mainthread.md rename to docs/plugins/essentials/threading/mainthread.md index d1064bd..e5bb8ef 100644 --- a/docs/plugins/essentials/mainthread.md +++ b/docs/plugins/essentials/threading/mainthread.md @@ -1,5 +1,5 @@ --- -uid: Plugins.Essentials.MainThread +uid: Plugins.Essentials.Threading.MainThread --- # Main Thread diff --git a/docs/plugins/essentials/threading/toc.yml b/docs/plugins/essentials/threading/toc.yml new file mode 100644 index 0000000..e8a188d --- /dev/null +++ b/docs/plugins/essentials/threading/toc.yml @@ -0,0 +1,2 @@ +- name: Main Thread + href: mainthread.md \ No newline at end of file diff --git a/docs/plugins/essentials/toc.yml b/docs/plugins/essentials/toc.yml index 2962737..82c0829 100644 --- a/docs/plugins/essentials/toc.yml +++ b/docs/plugins/essentials/toc.yml @@ -1,20 +1,16 @@ - name: Getting Started href: index.md -- name: App Context - href: appcontext.md -- name: Connectivity - href: connectivity.md -- name: File System - href: filesystem.md -- name: LatestVersion - href: latestversion.md -- name: Main Thread - href: mainthread.md +- name: ApplicationModel + href: applicationmodel/toc.yml +- name: Devices + href: devices/toc.yml +- name: IO + href: io/toc.yml +- name: Networking + href: networking/toc.yml - name: Notifications href: notifications/toc.yml - name: Permissions href: permissions.md -- name: Phone Dialer - href: phonedialer.md -- name: Stores - href: stores.md \ No newline at end of file +- name: Threading + href: threading/toc.yml \ No newline at end of file diff --git a/docs/plugins/logging/raygun.md b/docs/plugins/logging/raygun.md index 6a230e6..e876362 100644 --- a/docs/plugins/logging/raygun.md +++ b/docs/plugins/logging/raygun.md @@ -50,4 +50,4 @@ container.UsePrismLogging(logging => ## Prism.Essentials Integration -The Raygun Implementation of the Logger makes reference to the [Prism.Plugin.Essentials](xref:Plugins.Essentials.GettingStarted) library. This allows us to dynamically check if various Essentials interfaces have been registered. If they have we automatically tailor the Logger to include offline support with request caching. Additionally we will automatically update the configuration to make use of the [Application Context](xref:Plugins.Essentials.AppContext) from Essentials. In order to enable sending logs in the background with the offline store, be sure to Register Prism.Plugin.Essentials first. +The Raygun Implementation of the Logger makes reference to the [Prism.Plugin.Essentials](xref:Plugins.Essentials.GettingStarted) library. This allows us to dynamically check if various Essentials interfaces have been registered. If they have we automatically tailor the Logger to include offline support with request caching. Additionally we will automatically update the configuration to make use of the [Application Context](xref:Plugins.Essentials.ApplicationModel.AppContext) from Essentials. In order to enable sending logs in the background with the offline store, be sure to Register Prism.Plugin.Essentials first.