From 9c00d18edc4a7848d2ec18c10437e0b32a1f459e Mon Sep 17 00:00:00 2001 From: Pawan Jain Date: Thu, 19 Jun 2025 02:51:33 +0530 Subject: [PATCH 1/2] fix: remove TOC from API reference pages --- .../docs/api-reference/environments/create-an-environment.mdx | 1 + .../docs/api-reference/environments/delete-an-environment.mdx | 1 + .../docs/api-reference/environments/list-all-environments.mdx | 1 + .../docs/api-reference/environments/update-an-environment.mdx | 1 + content/docs/api-reference/events/broadcast-event-to-all.mdx | 1 + content/docs/api-reference/events/bulk-trigger-event.mdx | 1 + content/docs/api-reference/events/cancel-triggered-event.mdx | 1 + content/docs/api-reference/events/trigger-event.mdx | 1 + .../docs/api-reference/integrations/create-an-integration.mdx | 1 + .../docs/api-reference/integrations/delete-an-integration.mdx | 1 + .../api-reference/integrations/list-active-integrations.mdx | 1 + .../docs/api-reference/integrations/list-all-integrations.mdx | 1 + .../docs/api-reference/integrations/update-an-integration.mdx | 1 + .../integrations/update-integration-as-primary.mdx | 1 + content/docs/api-reference/messages/delete-a-message.mdx | 1 + .../api-reference/messages/delete-messages-by-transactionid.mdx | 1 + content/docs/api-reference/messages/list-all-messages.mdx | 1 + content/docs/api-reference/notifications/list-all-events.mdx | 1 + content/docs/api-reference/notifications/retrieve-an-event.mdx | 1 + .../docs/api-reference/subscribers/bulk-create-subscribers.mdx | 1 + content/docs/api-reference/subscribers/create-a-subscriber.mdx | 1 + content/docs/api-reference/subscribers/delete-a-subscriber.mdx | 1 + .../api-reference/subscribers/delete-provider-credentials.mdx | 1 + .../docs/api-reference/subscribers/retrieve-a-subscriber.mdx | 1 + .../subscribers/retrieve-subscriber-notifications.mdx | 1 + .../subscribers/retrieve-subscriber-preferences.mdx | 1 + .../subscribers/retrieve-subscriber-subscriptions.mdx | 1 + .../subscribers/retrieve-unseen-notifications-count.mdx | 1 + content/docs/api-reference/subscribers/search-subscribers.mdx | 1 + content/docs/api-reference/subscribers/update-a-subscriber.mdx | 1 + .../subscribers/update-all-notifications-state.mdx | 1 + .../subscribers/update-notification-action-status.mdx | 1 + .../api-reference/subscribers/update-notifications-state.mdx | 1 + .../api-reference/subscribers/update-provider-credentials.mdx | 1 + .../subscribers/update-subscriber-online-status.mdx | 1 + .../api-reference/subscribers/update-subscriber-preferences.mdx | 1 + .../api-reference/subscribers/upsert-provider-credentials.mdx | 1 + content/docs/api-reference/topics/check-topic-subscriber.mdx | 1 + content/docs/api-reference/topics/create-a-topic.mdx | 1 + .../docs/api-reference/topics/create-topic-subscriptions.mdx | 1 + content/docs/api-reference/topics/delete-a-topic.mdx | 1 + .../docs/api-reference/topics/delete-topic-subscriptions.mdx | 1 + content/docs/api-reference/topics/list-all-topics.mdx | 1 + content/docs/api-reference/topics/list-topic-subscriptions.mdx | 1 + content/docs/api-reference/topics/retrieve-a-topic.mdx | 1 + content/docs/api-reference/topics/update-a-topic.mdx | 1 + content/docs/api-reference/workflows/create-a-workflow.mdx | 1 + content/docs/api-reference/workflows/delete-a-workflow.mdx | 1 + content/docs/api-reference/workflows/list-all-workflows.mdx | 1 + content/docs/api-reference/workflows/retrieve-a-workflow.mdx | 1 + content/docs/api-reference/workflows/retrieve-workflow-step.mdx | 1 + content/docs/api-reference/workflows/sync-a-workflow.mdx | 1 + content/docs/api-reference/workflows/update-a-workflow.mdx | 1 + content/docs/platform/concepts/topics.mdx | 1 - content/docs/platform/concepts/workflows.mdx | 2 -- content/docs/platform/overview.mdx | 1 + 56 files changed, 54 insertions(+), 3 deletions(-) diff --git a/content/docs/api-reference/environments/create-an-environment.mdx b/content/docs/api-reference/environments/create-an-environment.mdx index 6e48487da..1eaa03232 100644 --- a/content/docs/api-reference/environments/create-an-environment.mdx +++ b/content/docs/api-reference/environments/create-an-environment.mdx @@ -1,6 +1,7 @@ --- title: Create an environment full: true +hideTOC: true _openapi: method: POST route: /v1/environments diff --git a/content/docs/api-reference/environments/delete-an-environment.mdx b/content/docs/api-reference/environments/delete-an-environment.mdx index 764d907dd..5d27dc7de 100644 --- a/content/docs/api-reference/environments/delete-an-environment.mdx +++ b/content/docs/api-reference/environments/delete-an-environment.mdx @@ -1,6 +1,7 @@ --- title: Delete an environment full: true +hideTOC: true _openapi: method: DELETE route: /v1/environments/{environmentId} diff --git a/content/docs/api-reference/environments/list-all-environments.mdx b/content/docs/api-reference/environments/list-all-environments.mdx index 1314c17c4..7931969fa 100644 --- a/content/docs/api-reference/environments/list-all-environments.mdx +++ b/content/docs/api-reference/environments/list-all-environments.mdx @@ -1,6 +1,7 @@ --- title: List all environments full: true +hideTOC: true _openapi: method: GET route: /v1/environments diff --git a/content/docs/api-reference/environments/update-an-environment.mdx b/content/docs/api-reference/environments/update-an-environment.mdx index 05a7fb55e..2d54673f0 100644 --- a/content/docs/api-reference/environments/update-an-environment.mdx +++ b/content/docs/api-reference/environments/update-an-environment.mdx @@ -1,6 +1,7 @@ --- title: Update an environment full: true +hideTOC: true _openapi: method: PUT route: /v1/environments/{environmentId} diff --git a/content/docs/api-reference/events/broadcast-event-to-all.mdx b/content/docs/api-reference/events/broadcast-event-to-all.mdx index 8c4fec04a..d4dd2443f 100644 --- a/content/docs/api-reference/events/broadcast-event-to-all.mdx +++ b/content/docs/api-reference/events/broadcast-event-to-all.mdx @@ -1,6 +1,7 @@ --- title: Broadcast event to all full: true +hideTOC: true _openapi: method: POST route: /v1/events/trigger/broadcast diff --git a/content/docs/api-reference/events/bulk-trigger-event.mdx b/content/docs/api-reference/events/bulk-trigger-event.mdx index 13fe9307e..293efc677 100644 --- a/content/docs/api-reference/events/bulk-trigger-event.mdx +++ b/content/docs/api-reference/events/bulk-trigger-event.mdx @@ -1,6 +1,7 @@ --- title: Bulk trigger event full: true +hideTOC: true _openapi: method: POST route: /v1/events/trigger/bulk diff --git a/content/docs/api-reference/events/cancel-triggered-event.mdx b/content/docs/api-reference/events/cancel-triggered-event.mdx index f8e7c2eca..a336043d9 100644 --- a/content/docs/api-reference/events/cancel-triggered-event.mdx +++ b/content/docs/api-reference/events/cancel-triggered-event.mdx @@ -1,6 +1,7 @@ --- title: Cancel triggered event full: true +hideTOC: true _openapi: method: DELETE route: /v1/events/trigger/{transactionId} diff --git a/content/docs/api-reference/events/trigger-event.mdx b/content/docs/api-reference/events/trigger-event.mdx index eea3877aa..f31eea3e7 100644 --- a/content/docs/api-reference/events/trigger-event.mdx +++ b/content/docs/api-reference/events/trigger-event.mdx @@ -1,6 +1,7 @@ --- title: Trigger event full: true +hideTOC: true _openapi: method: POST route: /v1/events/trigger diff --git a/content/docs/api-reference/integrations/create-an-integration.mdx b/content/docs/api-reference/integrations/create-an-integration.mdx index 6b26c858c..58091cdb7 100644 --- a/content/docs/api-reference/integrations/create-an-integration.mdx +++ b/content/docs/api-reference/integrations/create-an-integration.mdx @@ -1,6 +1,7 @@ --- title: Create an integration full: true +hideTOC: true _openapi: method: POST route: /v1/integrations diff --git a/content/docs/api-reference/integrations/delete-an-integration.mdx b/content/docs/api-reference/integrations/delete-an-integration.mdx index 3699b3f08..6503df9ff 100644 --- a/content/docs/api-reference/integrations/delete-an-integration.mdx +++ b/content/docs/api-reference/integrations/delete-an-integration.mdx @@ -1,6 +1,7 @@ --- title: Delete an integration full: true +hideTOC: true _openapi: method: DELETE route: /v1/integrations/{integrationId} diff --git a/content/docs/api-reference/integrations/list-active-integrations.mdx b/content/docs/api-reference/integrations/list-active-integrations.mdx index fe0a78426..fb4aa0261 100644 --- a/content/docs/api-reference/integrations/list-active-integrations.mdx +++ b/content/docs/api-reference/integrations/list-active-integrations.mdx @@ -1,6 +1,7 @@ --- title: List active integrations full: true +hideTOC: true _openapi: method: GET route: /v1/integrations/active diff --git a/content/docs/api-reference/integrations/list-all-integrations.mdx b/content/docs/api-reference/integrations/list-all-integrations.mdx index 3c5fae9b4..bce4218e9 100644 --- a/content/docs/api-reference/integrations/list-all-integrations.mdx +++ b/content/docs/api-reference/integrations/list-all-integrations.mdx @@ -1,6 +1,7 @@ --- title: List all integrations full: true +hideTOC: true _openapi: method: GET route: /v1/integrations diff --git a/content/docs/api-reference/integrations/update-an-integration.mdx b/content/docs/api-reference/integrations/update-an-integration.mdx index 9a6afef71..14c262a90 100644 --- a/content/docs/api-reference/integrations/update-an-integration.mdx +++ b/content/docs/api-reference/integrations/update-an-integration.mdx @@ -1,6 +1,7 @@ --- title: Update an integration full: true +hideTOC: true _openapi: method: PUT route: /v1/integrations/{integrationId} diff --git a/content/docs/api-reference/integrations/update-integration-as-primary.mdx b/content/docs/api-reference/integrations/update-integration-as-primary.mdx index 8a9cea213..d7bbfed36 100644 --- a/content/docs/api-reference/integrations/update-integration-as-primary.mdx +++ b/content/docs/api-reference/integrations/update-integration-as-primary.mdx @@ -1,6 +1,7 @@ --- title: Update integration as primary full: true +hideTOC: true _openapi: method: POST route: /v1/integrations/{integrationId}/set-primary diff --git a/content/docs/api-reference/messages/delete-a-message.mdx b/content/docs/api-reference/messages/delete-a-message.mdx index 8cf5fb4be..20c90f067 100644 --- a/content/docs/api-reference/messages/delete-a-message.mdx +++ b/content/docs/api-reference/messages/delete-a-message.mdx @@ -1,6 +1,7 @@ --- title: Delete a message full: true +hideTOC: true _openapi: method: DELETE route: /v1/messages/{messageId} diff --git a/content/docs/api-reference/messages/delete-messages-by-transactionid.mdx b/content/docs/api-reference/messages/delete-messages-by-transactionid.mdx index 655308499..d2865a572 100644 --- a/content/docs/api-reference/messages/delete-messages-by-transactionid.mdx +++ b/content/docs/api-reference/messages/delete-messages-by-transactionid.mdx @@ -1,6 +1,7 @@ --- title: Delete messages by transactionId full: true +hideTOC: true _openapi: method: DELETE route: /v1/messages/transaction/{transactionId} diff --git a/content/docs/api-reference/messages/list-all-messages.mdx b/content/docs/api-reference/messages/list-all-messages.mdx index 2fc116f30..3f0cdb407 100644 --- a/content/docs/api-reference/messages/list-all-messages.mdx +++ b/content/docs/api-reference/messages/list-all-messages.mdx @@ -1,6 +1,7 @@ --- title: List all messages full: true +hideTOC: true _openapi: method: GET route: /v1/messages diff --git a/content/docs/api-reference/notifications/list-all-events.mdx b/content/docs/api-reference/notifications/list-all-events.mdx index cc71031c9..478159ec8 100644 --- a/content/docs/api-reference/notifications/list-all-events.mdx +++ b/content/docs/api-reference/notifications/list-all-events.mdx @@ -1,6 +1,7 @@ --- title: List all events full: true +hideTOC: true _openapi: method: GET route: /v1/notifications diff --git a/content/docs/api-reference/notifications/retrieve-an-event.mdx b/content/docs/api-reference/notifications/retrieve-an-event.mdx index 470e750f4..6d6d0a43e 100644 --- a/content/docs/api-reference/notifications/retrieve-an-event.mdx +++ b/content/docs/api-reference/notifications/retrieve-an-event.mdx @@ -1,6 +1,7 @@ --- title: Retrieve an event full: true +hideTOC: true _openapi: method: GET route: /v1/notifications/{notificationId} diff --git a/content/docs/api-reference/subscribers/bulk-create-subscribers.mdx b/content/docs/api-reference/subscribers/bulk-create-subscribers.mdx index 61d0295aa..7373aac60 100644 --- a/content/docs/api-reference/subscribers/bulk-create-subscribers.mdx +++ b/content/docs/api-reference/subscribers/bulk-create-subscribers.mdx @@ -1,6 +1,7 @@ --- title: Bulk create subscribers full: true +hideTOC: true _openapi: method: POST route: /v1/subscribers/bulk diff --git a/content/docs/api-reference/subscribers/create-a-subscriber.mdx b/content/docs/api-reference/subscribers/create-a-subscriber.mdx index 610b6812e..15170774d 100644 --- a/content/docs/api-reference/subscribers/create-a-subscriber.mdx +++ b/content/docs/api-reference/subscribers/create-a-subscriber.mdx @@ -1,6 +1,7 @@ --- title: Create a subscriber full: true +hideTOC: true _openapi: method: POST route: /v2/subscribers diff --git a/content/docs/api-reference/subscribers/delete-a-subscriber.mdx b/content/docs/api-reference/subscribers/delete-a-subscriber.mdx index 94dbd34df..44c8bbe3d 100644 --- a/content/docs/api-reference/subscribers/delete-a-subscriber.mdx +++ b/content/docs/api-reference/subscribers/delete-a-subscriber.mdx @@ -1,6 +1,7 @@ --- title: Delete a subscriber full: true +hideTOC: true _openapi: method: DELETE route: /v2/subscribers/{subscriberId} diff --git a/content/docs/api-reference/subscribers/delete-provider-credentials.mdx b/content/docs/api-reference/subscribers/delete-provider-credentials.mdx index 76ce6446d..600426dbe 100644 --- a/content/docs/api-reference/subscribers/delete-provider-credentials.mdx +++ b/content/docs/api-reference/subscribers/delete-provider-credentials.mdx @@ -1,6 +1,7 @@ --- title: Delete provider credentials full: true +hideTOC: true _openapi: method: DELETE route: /v1/subscribers/{subscriberId}/credentials/{providerId} diff --git a/content/docs/api-reference/subscribers/retrieve-a-subscriber.mdx b/content/docs/api-reference/subscribers/retrieve-a-subscriber.mdx index 53bd2a17c..a16f539b0 100644 --- a/content/docs/api-reference/subscribers/retrieve-a-subscriber.mdx +++ b/content/docs/api-reference/subscribers/retrieve-a-subscriber.mdx @@ -1,6 +1,7 @@ --- title: Retrieve a subscriber full: true +hideTOC: true _openapi: method: GET route: /v2/subscribers/{subscriberId} diff --git a/content/docs/api-reference/subscribers/retrieve-subscriber-notifications.mdx b/content/docs/api-reference/subscribers/retrieve-subscriber-notifications.mdx index f1163921c..07c743def 100644 --- a/content/docs/api-reference/subscribers/retrieve-subscriber-notifications.mdx +++ b/content/docs/api-reference/subscribers/retrieve-subscriber-notifications.mdx @@ -1,6 +1,7 @@ --- title: Retrieve subscriber notifications full: true +hideTOC: true _openapi: method: GET route: /v1/subscribers/{subscriberId}/notifications/feed diff --git a/content/docs/api-reference/subscribers/retrieve-subscriber-preferences.mdx b/content/docs/api-reference/subscribers/retrieve-subscriber-preferences.mdx index b4994333c..25a7761f8 100644 --- a/content/docs/api-reference/subscribers/retrieve-subscriber-preferences.mdx +++ b/content/docs/api-reference/subscribers/retrieve-subscriber-preferences.mdx @@ -1,6 +1,7 @@ --- title: Retrieve subscriber preferences full: true +hideTOC: true _openapi: method: GET route: /v2/subscribers/{subscriberId}/preferences diff --git a/content/docs/api-reference/subscribers/retrieve-subscriber-subscriptions.mdx b/content/docs/api-reference/subscribers/retrieve-subscriber-subscriptions.mdx index a403520a7..d6c68bf8e 100644 --- a/content/docs/api-reference/subscribers/retrieve-subscriber-subscriptions.mdx +++ b/content/docs/api-reference/subscribers/retrieve-subscriber-subscriptions.mdx @@ -1,6 +1,7 @@ --- title: Retrieve subscriber subscriptions full: true +hideTOC: true _openapi: method: GET route: /v2/subscribers/{subscriberId}/subscriptions diff --git a/content/docs/api-reference/subscribers/retrieve-unseen-notifications-count.mdx b/content/docs/api-reference/subscribers/retrieve-unseen-notifications-count.mdx index 8831aa01a..0c985ff05 100644 --- a/content/docs/api-reference/subscribers/retrieve-unseen-notifications-count.mdx +++ b/content/docs/api-reference/subscribers/retrieve-unseen-notifications-count.mdx @@ -1,6 +1,7 @@ --- title: Retrieve unseen notifications count full: true +hideTOC: true _openapi: method: GET route: /v1/subscribers/{subscriberId}/notifications/unseen diff --git a/content/docs/api-reference/subscribers/search-subscribers.mdx b/content/docs/api-reference/subscribers/search-subscribers.mdx index b3081f750..f32c35352 100644 --- a/content/docs/api-reference/subscribers/search-subscribers.mdx +++ b/content/docs/api-reference/subscribers/search-subscribers.mdx @@ -1,6 +1,7 @@ --- title: Search subscribers full: true +hideTOC: true _openapi: method: GET route: /v2/subscribers diff --git a/content/docs/api-reference/subscribers/update-a-subscriber.mdx b/content/docs/api-reference/subscribers/update-a-subscriber.mdx index e75cabe3d..faa1dbeb5 100644 --- a/content/docs/api-reference/subscribers/update-a-subscriber.mdx +++ b/content/docs/api-reference/subscribers/update-a-subscriber.mdx @@ -1,6 +1,7 @@ --- title: Update a subscriber full: true +hideTOC: true _openapi: method: PATCH route: /v2/subscribers/{subscriberId} diff --git a/content/docs/api-reference/subscribers/update-all-notifications-state.mdx b/content/docs/api-reference/subscribers/update-all-notifications-state.mdx index 5c8e2488e..f4fc5c427 100644 --- a/content/docs/api-reference/subscribers/update-all-notifications-state.mdx +++ b/content/docs/api-reference/subscribers/update-all-notifications-state.mdx @@ -1,6 +1,7 @@ --- title: Update all notifications state full: true +hideTOC: true _openapi: method: POST route: /v1/subscribers/{subscriberId}/messages/mark-all diff --git a/content/docs/api-reference/subscribers/update-notification-action-status.mdx b/content/docs/api-reference/subscribers/update-notification-action-status.mdx index e323a2fe4..8cde5b51c 100644 --- a/content/docs/api-reference/subscribers/update-notification-action-status.mdx +++ b/content/docs/api-reference/subscribers/update-notification-action-status.mdx @@ -1,6 +1,7 @@ --- title: Update notification action status full: true +hideTOC: true _openapi: method: POST route: /v1/subscribers/{subscriberId}/messages/{messageId}/actions/{type} diff --git a/content/docs/api-reference/subscribers/update-notifications-state.mdx b/content/docs/api-reference/subscribers/update-notifications-state.mdx index 58f5fc5d3..79b3f74f5 100644 --- a/content/docs/api-reference/subscribers/update-notifications-state.mdx +++ b/content/docs/api-reference/subscribers/update-notifications-state.mdx @@ -1,6 +1,7 @@ --- title: Update notifications state full: true +hideTOC: true _openapi: method: POST route: /v1/subscribers/{subscriberId}/messages/mark-as diff --git a/content/docs/api-reference/subscribers/update-provider-credentials.mdx b/content/docs/api-reference/subscribers/update-provider-credentials.mdx index e5607ddfc..7ab5a1122 100644 --- a/content/docs/api-reference/subscribers/update-provider-credentials.mdx +++ b/content/docs/api-reference/subscribers/update-provider-credentials.mdx @@ -1,6 +1,7 @@ --- title: Update provider credentials full: true +hideTOC: true _openapi: method: PUT route: /v1/subscribers/{subscriberId}/credentials diff --git a/content/docs/api-reference/subscribers/update-subscriber-online-status.mdx b/content/docs/api-reference/subscribers/update-subscriber-online-status.mdx index 7e016c465..e0649e00e 100644 --- a/content/docs/api-reference/subscribers/update-subscriber-online-status.mdx +++ b/content/docs/api-reference/subscribers/update-subscriber-online-status.mdx @@ -1,6 +1,7 @@ --- title: Update subscriber online status full: true +hideTOC: true _openapi: method: PATCH route: /v1/subscribers/{subscriberId}/online-status diff --git a/content/docs/api-reference/subscribers/update-subscriber-preferences.mdx b/content/docs/api-reference/subscribers/update-subscriber-preferences.mdx index 03757c209..77b8d04ba 100644 --- a/content/docs/api-reference/subscribers/update-subscriber-preferences.mdx +++ b/content/docs/api-reference/subscribers/update-subscriber-preferences.mdx @@ -1,6 +1,7 @@ --- title: Update subscriber preferences full: true +hideTOC: true _openapi: method: PATCH route: /v2/subscribers/{subscriberId}/preferences diff --git a/content/docs/api-reference/subscribers/upsert-provider-credentials.mdx b/content/docs/api-reference/subscribers/upsert-provider-credentials.mdx index 620e0df34..a039204ff 100644 --- a/content/docs/api-reference/subscribers/upsert-provider-credentials.mdx +++ b/content/docs/api-reference/subscribers/upsert-provider-credentials.mdx @@ -1,6 +1,7 @@ --- title: Upsert provider credentials full: true +hideTOC: true _openapi: method: PATCH route: /v1/subscribers/{subscriberId}/credentials diff --git a/content/docs/api-reference/topics/check-topic-subscriber.mdx b/content/docs/api-reference/topics/check-topic-subscriber.mdx index 29b95584c..f74543953 100644 --- a/content/docs/api-reference/topics/check-topic-subscriber.mdx +++ b/content/docs/api-reference/topics/check-topic-subscriber.mdx @@ -1,6 +1,7 @@ --- title: Check topic subscriber full: true +hideTOC: true _openapi: method: GET route: /v1/topics/{topicKey}/subscribers/{externalSubscriberId} diff --git a/content/docs/api-reference/topics/create-a-topic.mdx b/content/docs/api-reference/topics/create-a-topic.mdx index 5e6878cb7..d983acf02 100644 --- a/content/docs/api-reference/topics/create-a-topic.mdx +++ b/content/docs/api-reference/topics/create-a-topic.mdx @@ -1,6 +1,7 @@ --- title: Create a topic full: true +hideTOC: true _openapi: method: POST route: /v2/topics diff --git a/content/docs/api-reference/topics/create-topic-subscriptions.mdx b/content/docs/api-reference/topics/create-topic-subscriptions.mdx index 72dd1d784..e79daca13 100644 --- a/content/docs/api-reference/topics/create-topic-subscriptions.mdx +++ b/content/docs/api-reference/topics/create-topic-subscriptions.mdx @@ -1,6 +1,7 @@ --- title: Create topic subscriptions full: true +hideTOC: true _openapi: method: POST route: /v2/topics/{topicKey}/subscriptions diff --git a/content/docs/api-reference/topics/delete-a-topic.mdx b/content/docs/api-reference/topics/delete-a-topic.mdx index 871c67104..05a379321 100644 --- a/content/docs/api-reference/topics/delete-a-topic.mdx +++ b/content/docs/api-reference/topics/delete-a-topic.mdx @@ -1,6 +1,7 @@ --- title: Delete a topic full: true +hideTOC: true _openapi: method: DELETE route: /v2/topics/{topicKey} diff --git a/content/docs/api-reference/topics/delete-topic-subscriptions.mdx b/content/docs/api-reference/topics/delete-topic-subscriptions.mdx index 62c9384cc..090e96786 100644 --- a/content/docs/api-reference/topics/delete-topic-subscriptions.mdx +++ b/content/docs/api-reference/topics/delete-topic-subscriptions.mdx @@ -1,6 +1,7 @@ --- title: Delete topic subscriptions full: true +hideTOC: true _openapi: method: DELETE route: /v2/topics/{topicKey}/subscriptions diff --git a/content/docs/api-reference/topics/list-all-topics.mdx b/content/docs/api-reference/topics/list-all-topics.mdx index 6787379a9..19423c80f 100644 --- a/content/docs/api-reference/topics/list-all-topics.mdx +++ b/content/docs/api-reference/topics/list-all-topics.mdx @@ -1,6 +1,7 @@ --- title: List all topics full: true +hideTOC: true _openapi: method: GET route: /v2/topics diff --git a/content/docs/api-reference/topics/list-topic-subscriptions.mdx b/content/docs/api-reference/topics/list-topic-subscriptions.mdx index d12879f97..55d0abb37 100644 --- a/content/docs/api-reference/topics/list-topic-subscriptions.mdx +++ b/content/docs/api-reference/topics/list-topic-subscriptions.mdx @@ -1,6 +1,7 @@ --- title: List topic subscriptions full: true +hideTOC: true _openapi: method: GET route: /v2/topics/{topicKey}/subscriptions diff --git a/content/docs/api-reference/topics/retrieve-a-topic.mdx b/content/docs/api-reference/topics/retrieve-a-topic.mdx index 1edee2661..f1d913843 100644 --- a/content/docs/api-reference/topics/retrieve-a-topic.mdx +++ b/content/docs/api-reference/topics/retrieve-a-topic.mdx @@ -1,6 +1,7 @@ --- title: Retrieve a topic full: true +hideTOC: true _openapi: method: GET route: /v2/topics/{topicKey} diff --git a/content/docs/api-reference/topics/update-a-topic.mdx b/content/docs/api-reference/topics/update-a-topic.mdx index 96374fc08..9bd0939dd 100644 --- a/content/docs/api-reference/topics/update-a-topic.mdx +++ b/content/docs/api-reference/topics/update-a-topic.mdx @@ -1,6 +1,7 @@ --- title: Update a topic full: true +hideTOC: true _openapi: method: PATCH route: /v2/topics/{topicKey} diff --git a/content/docs/api-reference/workflows/create-a-workflow.mdx b/content/docs/api-reference/workflows/create-a-workflow.mdx index 5db9ee145..99acc4341 100644 --- a/content/docs/api-reference/workflows/create-a-workflow.mdx +++ b/content/docs/api-reference/workflows/create-a-workflow.mdx @@ -1,6 +1,7 @@ --- title: Create a workflow full: true +hideTOC: true _openapi: method: POST route: /v2/workflows diff --git a/content/docs/api-reference/workflows/delete-a-workflow.mdx b/content/docs/api-reference/workflows/delete-a-workflow.mdx index 2ca46b964..5577bac8d 100644 --- a/content/docs/api-reference/workflows/delete-a-workflow.mdx +++ b/content/docs/api-reference/workflows/delete-a-workflow.mdx @@ -1,6 +1,7 @@ --- title: Delete a workflow full: true +hideTOC: true _openapi: method: DELETE route: /v2/workflows/{workflowId} diff --git a/content/docs/api-reference/workflows/list-all-workflows.mdx b/content/docs/api-reference/workflows/list-all-workflows.mdx index a6e8eb200..13863be8a 100644 --- a/content/docs/api-reference/workflows/list-all-workflows.mdx +++ b/content/docs/api-reference/workflows/list-all-workflows.mdx @@ -1,6 +1,7 @@ --- title: List all workflows full: true +hideTOC: true _openapi: method: GET route: /v2/workflows diff --git a/content/docs/api-reference/workflows/retrieve-a-workflow.mdx b/content/docs/api-reference/workflows/retrieve-a-workflow.mdx index f26818ea5..8a4ea8104 100644 --- a/content/docs/api-reference/workflows/retrieve-a-workflow.mdx +++ b/content/docs/api-reference/workflows/retrieve-a-workflow.mdx @@ -1,6 +1,7 @@ --- title: Retrieve a workflow full: true +hideTOC: true _openapi: method: GET route: /v2/workflows/{workflowId} diff --git a/content/docs/api-reference/workflows/retrieve-workflow-step.mdx b/content/docs/api-reference/workflows/retrieve-workflow-step.mdx index 420846811..d1ddfcc8b 100644 --- a/content/docs/api-reference/workflows/retrieve-workflow-step.mdx +++ b/content/docs/api-reference/workflows/retrieve-workflow-step.mdx @@ -1,6 +1,7 @@ --- title: Retrieve workflow step full: true +hideTOC: true _openapi: method: GET route: /v2/workflows/{workflowId}/steps/{stepId} diff --git a/content/docs/api-reference/workflows/sync-a-workflow.mdx b/content/docs/api-reference/workflows/sync-a-workflow.mdx index 16ee26000..1a8f7cb4e 100644 --- a/content/docs/api-reference/workflows/sync-a-workflow.mdx +++ b/content/docs/api-reference/workflows/sync-a-workflow.mdx @@ -1,6 +1,7 @@ --- title: Sync a workflow full: true +hideTOC: true _openapi: method: PUT route: /v2/workflows/{workflowId}/sync diff --git a/content/docs/api-reference/workflows/update-a-workflow.mdx b/content/docs/api-reference/workflows/update-a-workflow.mdx index 6cabc9797..7d34a8b16 100644 --- a/content/docs/api-reference/workflows/update-a-workflow.mdx +++ b/content/docs/api-reference/workflows/update-a-workflow.mdx @@ -1,6 +1,7 @@ --- title: Update a workflow full: true +hideTOC: true _openapi: method: PUT route: /v2/workflows/{workflowId} diff --git a/content/docs/platform/concepts/topics.mdx b/content/docs/platform/concepts/topics.mdx index 0985a2792..6a29495bb 100644 --- a/content/docs/platform/concepts/topics.mdx +++ b/content/docs/platform/concepts/topics.mdx @@ -3,7 +3,6 @@ title: 'Topics' description: 'Learn how topics work in Novu and how they help you organize and target groups of subscribers efficiently.' icon: 'Folders' --- -import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; In Novu, a _topic_ is a way to group subscribers under a shared label so that you can broadcast a message to many users with a single workflow trigger. This fan-out mechanism removes the need to manage individual subscriber IDs for each notification, streamlining scenarios like product announcements, feature rollouts, or status updates. diff --git a/content/docs/platform/concepts/workflows.mdx b/content/docs/platform/concepts/workflows.mdx index b9dc00ebc..775edafb4 100644 --- a/content/docs/platform/concepts/workflows.mdx +++ b/content/docs/platform/concepts/workflows.mdx @@ -3,8 +3,6 @@ title: 'Workflows' description: 'Learn what workflows are and how they work in Novu.' icon: 'Workflow' --- -import { Tab, Tabs } from 'fumadocs-ui/components/tabs'; -import { Accordion, Accordions } from 'fumadocs-ui/components/accordion'; In Novu, a workflow is the blueprint that defines the end-to-end process for delivering a notification to one or more subscribers. It acts as the central logic layer for routing messages across different channels such as email, SMS, in-app, push, or chat and controlling what notification to send, when to send it and through which channels they are sent. diff --git a/content/docs/platform/overview.mdx b/content/docs/platform/overview.mdx index b2fd768fc..1c20544da 100644 --- a/content/docs/platform/overview.mdx +++ b/content/docs/platform/overview.mdx @@ -2,6 +2,7 @@ title: Overview pageTitle: '' icon: LayoutDashboard +hideTOC: true --- import { OverviewPage } from '@/components/pages/overview-page'; From bfaca9236829fbad9071e59ce9aaf37748be07ac Mon Sep 17 00:00:00 2001 From: Pawan Jain Date: Thu, 19 Jun 2025 02:52:41 +0530 Subject: [PATCH 2/2] add hover border color to cards --- scripts/generate-docs.mjs | 7 +++++++ source.config.ts | 1 + src/app/[[...slug]]/page.tsx | 13 +++++++------ src/components/card.tsx | 2 +- src/lib/get-systems-status.ts | 4 +++- 5 files changed, 19 insertions(+), 8 deletions(-) diff --git a/scripts/generate-docs.mjs b/scripts/generate-docs.mjs index 66b4b0454..c104b373e 100644 --- a/scripts/generate-docs.mjs +++ b/scripts/generate-docs.mjs @@ -38,6 +38,13 @@ async function main() { const pages = await OpenAPI.generatePages(openApiInput[0], { includeDescription: true, + frontmatter: (title, description, context) => { + return { + full: true, + hideTOC: true, + title: title, + }; + }, }); // Structure to hold metadata for each tag: Map> diff --git a/source.config.ts b/source.config.ts index 6de1c9ddd..8b12d5b4d 100644 --- a/source.config.ts +++ b/source.config.ts @@ -17,6 +17,7 @@ export const docs = defineDocs({ * API routes only */ method: z.string().optional(), + hideTOC: z.boolean().default(false), }), }, meta: { diff --git a/src/app/[[...slug]]/page.tsx b/src/app/[[...slug]]/page.tsx index 9f782345c..d618fe743 100644 --- a/src/app/[[...slug]]/page.tsx +++ b/src/app/[[...slug]]/page.tsx @@ -22,6 +22,7 @@ import { metadataImage } from '../../lib/metadata-image'; import { ImageZoom } from 'fumadocs-ui/components/image-zoom'; import { PageActions } from '../../components/page-actions'; import { getRawMarkdownContent } from '../../lib/get-markdown-content'; +import { Card, Cards } from '@/components/card'; export default async function Page(props: { params: Promise<{ slug?: string[] }> }) { const params = await props.params; @@ -31,9 +32,7 @@ export default async function Page(props: { params: Promise<{ slug?: string[] }> const MDX = page.data.body; - const isOverviewPage = - page.file.path.endsWith('platform/overview.mdx') || - page.slugs.join('/') === 'platform/overview'; + const hideTOC = (page?.data?._exports?.frontmatter as any)?.hideTOC; const rawMarkdownContent = getRawMarkdownContent(page.file.path); @@ -42,13 +41,13 @@ export default async function Page(props: { params: Promise<{ slug?: string[] }> return ( ), + Cards: Cards, + Card: Card, img: (props) => , }} /> diff --git a/src/components/card.tsx b/src/components/card.tsx index c140a5f1a..2b122e16d 100644 --- a/src/components/card.tsx +++ b/src/components/card.tsx @@ -27,7 +27,7 @@ export function Card({ icon, title, description, ...props }: CardProps): React.R {...props} data-card className={cn( - 'block rounded-lg border bg-fd-card p-4 text-fd-card-foreground shadow-md transition-colors', + 'block rounded-lg border-2 hover:border-[#4b73ec] bg-fd-card p-4 text-fd-card-foreground shadow-md transition-colors', props.href && 'hover:bg-fd-accent/80', props.className )} diff --git a/src/lib/get-systems-status.ts b/src/lib/get-systems-status.ts index 47350e992..00513c560 100644 --- a/src/lib/get-systems-status.ts +++ b/src/lib/get-systems-status.ts @@ -73,7 +73,9 @@ export type SystemStatusType = { export async function getSystemsStatus(): Promise { if (!process.env.BETTERSTACK_API_KEY) { - throw new Error('Missing BETTERSTACK_API_KEY environment variable'); + // eslint-disable-next-line no-console + console.error('Missing BETTERSTACK_API_KEY environment variable'); + return []; } const response = await fetch('https://uptime.betterstack.com/api/v2/monitors', {