From 2b61c6efba0281988c8303a47a647b8153c4ef5e Mon Sep 17 00:00:00 2001 From: Justin Nemmers Date: Tue, 14 Jan 2025 09:51:16 -0500 Subject: [PATCH 1/3] feat: re-add dev and product pages --- getting-started/developers.mdx | 26 ++++++++++++++++++++++++++ getting-started/product-teams.mdx | 16 ++++++++++++++++ 2 files changed, 42 insertions(+) create mode 100644 getting-started/developers.mdx create mode 100644 getting-started/product-teams.mdx diff --git a/getting-started/developers.mdx b/getting-started/developers.mdx new file mode 100644 index 00000000..9e055468 --- /dev/null +++ b/getting-started/developers.mdx @@ -0,0 +1,26 @@ +--- +title: "Novu for Developers" +description: "Novu is a powerful notifications platform designed for developers and engineers to build, manage, and deliver scalable, extensible, and captivating multi-channel notification experiences while empowering product teams with intuitive tools and prebuilt components." +--- + +## Who is Novu for? + +How you use and get started with Novu depends on your role. While it’s initially implemented by engineering and development teams, Novu unifies everyone in an organization that authors, creates, sends, manages, and measures results from notifications being sent to end users. Novu empowers engineers to deliver notification platforms for product teams. + +### Novu for developers and engineers + +Novu empowers developers and engineering teams to quickly deliver a fully extensible notifications platform for product teams to create captivating notification experiences. + +We provide the following proven stack for developers to simply integrate notifications into their products: + +- **[Code-first Notification Framework](/sdks/framework/typescript/overview)** Opinionated, yet flexible, Framework for building and managing notification workflows. +- **[JSON Schema Based](/api-reference/overview)** Controls to craft a no-code visual editor to enable non-technical team members to modify content and behaviour. +- **[Prebuilt, customisable UI components](/inbox/introduction)** for in-app user notification feeds and preference experiences. +- **[Integration with multiple delivery providers](/integrations/providers/introduction)**, allowing you to continue using your preferred vendors with Novu. +- **[Scalable, reliable Novu Cloud SaaS infrastructure](https://dashboard.novu.co)** developed from scratch to meet the demands of high-volume notification delivery and storage (think hundreds of millions of notifications). +- **Observability** for delving into the lifecycle of a notification's success or failure. Eliminate guesswork of how, when, and why a user receives a notification. +- **Comprehensive documentation**, implementation guides, recipes and illustrative examples. +- **Compliance and security** for safely managing your data. +- **Open source** provides transparency you can trust, cultivates community contributions for fast improvement, and enables you to deploy and self-host a Novu instance into any environment of your choosing. + +Notification content can be written in a variety of common content tooling, including [React](/integrations/react-email), [Vue-email](/integrations/vue-email), MJML, and more. Content can also be customized and hydrated using any datasource. \ No newline at end of file diff --git a/getting-started/product-teams.mdx b/getting-started/product-teams.mdx new file mode 100644 index 00000000..b854b385 --- /dev/null +++ b/getting-started/product-teams.mdx @@ -0,0 +1,16 @@ +--- +title: "No-Code tools to manage your notifications" +sidebarTitle: "Novu For Product Teams" +description: "Change notification messaging, verbiage, and cadence without requiring engineering's help by using the Novu Dashboard UI." +--- + +## Novu for product teams + +We are well aware of the friction that often exists between engineering and product teams, and have built features that allow product teams to customize notification experiences easily and safely—without the risk of breaking important integrations and logic. + +Product teams can craft beautiful notification content and campaigns in any content framework of their choice. +- Modify and manage notification UIs that engineers have built via the Novu Framework. +- Gain valuable insights into user engagement with notifications via logs and analytics. +- Use your preferred notification content editors. +- Craft impactful notification messaging, verbiage, and cadences. +- Run experiments to improve user experience without requiring engineering effort. \ No newline at end of file From 9cb3f456d8026a88ba0e7a9fdf6ee6c347a22f84 Mon Sep 17 00:00:00 2001 From: Justin Nemmers Date: Tue, 14 Jan 2025 09:54:46 -0500 Subject: [PATCH 2/3] chore: modify structure --- getting-started/how-novu-works.mdx | 2 +- getting-started/non-technical.mdx | 41 ------------------- getting-started/{ => novu-for}/developers.mdx | 0 .../product.mdx} | 0 4 files changed, 1 insertion(+), 42 deletions(-) delete mode 100644 getting-started/non-technical.mdx rename getting-started/{ => novu-for}/developers.mdx (100%) rename getting-started/{product-teams.mdx => novu-for/product.mdx} (100%) diff --git a/getting-started/how-novu-works.mdx b/getting-started/how-novu-works.mdx index 19146021..18bb8469 100644 --- a/getting-started/how-novu-works.mdx +++ b/getting-started/how-novu-works.mdx @@ -39,7 +39,7 @@ Instead of juggling multiple providers' APIs and SDKs, you get a single, consist - Power real-time notification feeds with our [full-stack UI Components libraries](/inbox/overview) - Handle notification templates and workflows -And so much more. +And much more. **This is a robust, highly customizable infrastructure layer that sits between your application and the user's devices and channels.** diff --git a/getting-started/non-technical.mdx b/getting-started/non-technical.mdx deleted file mode 100644 index 536f7271..00000000 --- a/getting-started/non-technical.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "No-Code tools to manage your notifications" -sidebarTitle: "For non-developers" -description: "Change notification messaging, verbiage, and cadence without requiring engineering's help by using the Novu Dashboard UI." ---- - -Novu Framework was designed to bridge the gap between developers and non-developers in the team. - -- **Developers** - Define and abstract away complex logic, data manipulation, hydration, html, and etc... -- **Non-Developers** - Use the Novu Dashboard UI to control the content and behavior of the notifications using [controls](/framework/controls). - -## How to modify controls? - -Controls are modified directly in the [Novu Dashboard UI](https://dashboard-v2.novu.co), under the 'Step controls' tab of the **Workflow Editor** page. -Upon saving the changes, the new Control values will be used in the notification sent to your subscribers. - -## Dynamic payload data - -Dynamic data passed as part of the trigger payload can be easily used inside of the Controls. For example, you can pass a `user_name` as part of the payload and use it in the controls as `{{payload.user_name}}` to personalize the notification. - -## Common usecases - -### Change notification content - -A control can be as broad as `content` or as specific as `2fa_code_title_color`. This allows you to change the content of the notification without needing to touch the code. - -### Change digest or delay frequency - -Controls can be used for controlling any aspect of the step configuration, for example: - -- Delay amount -- Digest length -- Digest type (daily, weekly, monthly) -- etc... - -Read more about [digest strategies and how to prevent notification fatigue.](https://novu.co/blog/digest-notifications-best-practices-example/) - -### Control structure and layout - -Controls can be used to show/hide or rearrange the layout of the notification. -For example, you can have an input to show/hide a button, or change the position of a specific email section. diff --git a/getting-started/developers.mdx b/getting-started/novu-for/developers.mdx similarity index 100% rename from getting-started/developers.mdx rename to getting-started/novu-for/developers.mdx diff --git a/getting-started/product-teams.mdx b/getting-started/novu-for/product.mdx similarity index 100% rename from getting-started/product-teams.mdx rename to getting-started/novu-for/product.mdx From 0990ff9f69fa3f7eba6a4ecc8094f945ab6e92ca Mon Sep 17 00:00:00 2001 From: Justin Nemmers Date: Tue, 14 Jan 2025 10:02:58 -0500 Subject: [PATCH 3/3] chore: update content, add to menu --- getting-started/novu-for/developers.mdx | 1 + getting-started/novu-for/product.mdx | 47 ++++++++++++++++++++----- mint.json | 11 ++++-- 3 files changed, 48 insertions(+), 11 deletions(-) diff --git a/getting-started/novu-for/developers.mdx b/getting-started/novu-for/developers.mdx index 9e055468..cb750a83 100644 --- a/getting-started/novu-for/developers.mdx +++ b/getting-started/novu-for/developers.mdx @@ -1,5 +1,6 @@ --- title: "Novu for Developers" +sidebarTitle: "Developers" description: "Novu is a powerful notifications platform designed for developers and engineers to build, manage, and deliver scalable, extensible, and captivating multi-channel notification experiences while empowering product teams with intuitive tools and prebuilt components." --- diff --git a/getting-started/novu-for/product.mdx b/getting-started/novu-for/product.mdx index b854b385..6b5a179d 100644 --- a/getting-started/novu-for/product.mdx +++ b/getting-started/novu-for/product.mdx @@ -1,16 +1,45 @@ --- title: "No-Code tools to manage your notifications" -sidebarTitle: "Novu For Product Teams" +sidebarTitle: "Product Teams" description: "Change notification messaging, verbiage, and cadence without requiring engineering's help by using the Novu Dashboard UI." --- -## Novu for product teams +Novu Framework was designed to bridge the gap between developers and non-developers in the team. -We are well aware of the friction that often exists between engineering and product teams, and have built features that allow product teams to customize notification experiences easily and safely—without the risk of breaking important integrations and logic. +- **Developers** - Define and abstract away complex logic, data manipulation, hydration, html, and etc... +- **Non-Developers** - Use the Novu Dashboard UI to control the content and behavior of the notifications using [controls](/framework/controls). -Product teams can craft beautiful notification content and campaigns in any content framework of their choice. -- Modify and manage notification UIs that engineers have built via the Novu Framework. -- Gain valuable insights into user engagement with notifications via logs and analytics. -- Use your preferred notification content editors. -- Craft impactful notification messaging, verbiage, and cadences. -- Run experiments to improve user experience without requiring engineering effort. \ No newline at end of file +## How to modify controls? + +Controls are modified directly in the [Novu Dashboard UI](https://dashboard-v2.novu.co), under the 'Step controls' tab of the **Workflow Editor** page. +Upon saving the changes, the new Control values will be used in the notification sent to your subscribers. + +## Dynamic payload data + +Dynamic data passed as part of the trigger payload can be easily used inside of the Controls. For example, you can pass a `user_name` as part of the payload and use it in the controls as `{{payload.user_name}}` to personalize the notification. + +## Common usecases + +### Change notification content + +A control can be as broad as `content` or as specific as `2fa_code_title_color`. This allows you to change the content of the notification without needing to touch the code. + +### Create new email designs + +Novu's built-in email editor enables rich content creation without ever touching the code. + +### Change digest or delay frequency + +Controls can be used for controlling any aspect of the step configuration, for example: + +- Delay amount +- Digest length +- Digest type (daily, weekly, monthly) +- etc... + +Read more about [digest strategies and how to prevent notification fatigue.](https://novu.co/blog/digest-notifications-best-practices-example/) + +### Control structure and layout + +Controls can be used to show/hide or rearrange the layout of the notification. +For example, you can have an input to show/hide a button, or change the position of a specific email section. \ No newline at end of file diff --git a/mint.json b/mint.json index e79edc93..9e6a364e 100644 --- a/mint.json +++ b/mint.json @@ -40,8 +40,8 @@ } ], "topbarCtaButton": { - "name": "Get Started", - "url": "https://dashboard-v2.novu.co/?utm_campaign=docs_top_bar_gs", + "name": "Try Novu", + "url": "https://dashboard-v2.novu.co/?utm_campaign=docs_top_bar_tn", "style": "pill", "arrow": true }, @@ -78,6 +78,13 @@ "getting-started/quickstart" ] }, + { + "group": "Novu for...", + "pages": [ + "getting-started/novu-for/developers", + "getting-started/novu-for/product" + ] + }, { "group": "Get started", "pages": [