wip(feathers-webpush): Migrate feathers-webpush to this monorepo #2 (docs)

Author: cnouguier

docs/packages/feathers-webpush/api/client.md

@@ -1,5 +1,6 @@
 ---
-title: Client
+title: Client API
+description: Client-side utilities for web push notifications
 ---
 
 # Client
@@ -18,8 +19,6 @@ It verifies:
 |------|-------------|
 | `NotificationsNotSupported` (498) | If the browser does not support push notifications or the Notifications API. |
 
----
-
 ## requestNotificationPermission()
 
 Requests the user's permission to display notifications.
@@ -38,8 +37,6 @@ If the current permission state is `default`, the browser prompts the user to gr
 |------|-------------|
 | `PermissionDeniedNotifications` (499) | If permission is denied (either previously or during the request). |
 
----
-
 ## getPushSubscription()
 
 Retrieves the current push subscription from the registered service worker.
@@ -56,8 +53,6 @@ Retrieves the current push subscription from the registered service worker.
 |------|-------------|
 | `ServiceWorkerNotRegistered` (497) | If no service worker is registered. |
 
----
-
 ## subscribePushNotifications(publicVapidKey)
 
 Subscribes the user to push notifications using the provided VAPID public key.
@@ -74,8 +69,6 @@ Subscribes the user to push notifications using the provided VAPID public key.
 |------|-------------|
 | `Promise<Object>` | Resolves to a serializable push subscription object. |
 
----
-
 ## unsubscribePushNotifications()
 
 Unsubscribes the current push subscription.
@@ -86,8 +79,6 @@ Unsubscribes the current push subscription.
 |------|-------------|
 | `Promise<PushSubscription>` | Resolves to the unsubscribed `PushSubscription` object. |
 
----
-
 ## addSubscription(subscription, currentSubscription, subscriptionProperty)
 
 Adds a push subscription to a subscription container object if it does not already exist.
@@ -108,8 +99,6 @@ If the subscription already exists (same `endpoint`), it is not duplicated.
 |------|-------------|
 | `Array` | The updated array of subscriptions. |
 
----
-
 ## removeSubscription(subscription, currentSubscription, subscriptionProperty)
 
 Removes a push subscription from a subscription container object.

docs/packages/feathers-webpush/api/server/hooks.md

@@ -1,5 +1,6 @@
 ---
 title: hooks
+description: Feathers hooks for managing and cleaning up web push subscriptions automatically
 ---
 
 # Hooks

docs/packages/feathers-webpush/api/server/service.md

@@ -1,5 +1,6 @@
 ---
 title: Service
+description: A Feathers service for sending web push notifications
 ---
 
 # Service

docs/packages/feathers-webpush/index.md

@@ -1,3 +1,8 @@
+---
+title: feathers-webpush
+description: Overview of feathers-webpush
+---
+
 # feathers-webpush
 
 **feathers-webpush** module provides a simplified way to send web push notifications in a FeathersJS application. It leverages the [web-push package](https://github.com/web-push-libs/web-push) to interact with the [Web Push protocol](https://web.dev/articles/push-notifications-web-push-protocol).
@@ -12,14 +17,10 @@ pnpm add @kalisio/feathers-webpush
 
 ## Configuration
 
-The provided [example](./example/README.md) illustrates how to setup:
 
-* a server app
 
-https://github.com/kalisio/feathers-webpush/blob/6b09d58428923c95e26cd5keycloak-listener8d130bc6b268c4cb30/example/server.mjs#L1-L46
 
-* a client app
+## Examples
 
-https://github.com/kalisio/feathers-webpush/blob/6b09d58428923c95e26cd58d130bc6b268c4cb30/example/src/index.html#L1-L66
+A complete [example](https://github.com/kalisio/feathers-ekosystem/tree/master/packages/examples/feathers-webpush) is provided.
 
-https://github.com/kalisio/feathers-webpush/blob/6b09d58428923c95e26cd58d130bc6b268c4cb30/example/src/index.js#L1-L122