Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/docs/api-reference/contexts/context-schema.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Context schema
pageTitle: "Context schema API Reference (Contexts)"
description: "Reference the Novu context schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Context
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Context schema
pageTitle: "Context schema Model API Reference (Contexts)"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix pageTitle casing consistency.

Line 3 has awkward mixed casing (“Context schema Model…”). Consider title case for cleaner SERP presentation.

Suggested metadata tweak
-pageTitle: "Context schema Model API Reference (Contexts)"
+pageTitle: "Context Schema Model API Reference (Contexts)"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
pageTitle: "Context schema Model API Reference (Contexts)"
pageTitle: "Context Schema Model API Reference (Contexts)"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/docs/api-reference/contexts/context-schema.model.mdx` at line 3,
Update the pageTitle metadata key to use consistent Title Case (e.g., "Context
Schema Model API Reference (Contexts)") instead of the mixed casing "Context
schema Model API Reference (Contexts)"; locate the pageTitle field in the
frontmatter/metadata (the pageTitle variable) and change the string to the
corrected Title Case form to ensure consistent SERP presentation.

description: "Reference the Novu context schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Context
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Environment schema
pageTitle: "Environment schema API Reference (Environments)"
description: "Reference the Novu environment schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Environment
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Environment schema
pageTitle: "Environment schema Model API Reference (Environments)"
description: "Reference the Novu environment schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Environment
Expand Down
2 changes: 1 addition & 1 deletion content/docs/api-reference/idempotency.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Idempotency'
pageTitle: 'API Idempotency'
pageTitle: "API Idempotency"
description: "Learn how to use idempotency keys to safely retry API requests without causing duplicate operations"
---

Expand Down
3 changes: 1 addition & 2 deletions content/docs/api-reference/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: 'Overview'
pageTitle: 'Novu REST API'
description: "In this page you can learn about how to work with Novu's API"
pageTitle: "Novu API Reference Overview"
---

<Callout>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Integration schema
pageTitle: "Integration schema API Reference (Integrations)"
description: "Reference the Novu integration schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Integration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Integration schema
pageTitle: "Integration schema Model API Reference (Integrations)"
description: "Reference the Novu integration schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Integration
Expand Down
2 changes: 2 additions & 0 deletions content/docs/api-reference/messages/message-schema.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Message schema
pageTitle: "Message schema API Reference (Messages)"
description: "Reference the Novu message schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Message
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Message schema
pageTitle: "Message schema Model API Reference (Messages)"
description: "Reference the Novu message schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Message
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Notification event schema
pageTitle: "Notification event schema API Reference (Notifications)"
description: "Reference the Novu notification event schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Notification event
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Notification event schema
pageTitle: "Notification event schema Model API Reference (Notifications)"
description: "Reference the Novu notification event schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Notification event
Expand Down
5 changes: 2 additions & 3 deletions content/docs/api-reference/payload-limits.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Payload Limits'
pageTitle: 'API Payload Limits'
description: "Learn about payload limits when working with Novu's API."
pageTitle: "API Payload Limits"
description: "Understand payload size limits for Novu API requests and workflow triggers. Structure event payloads to avoid validation failures and rejected requests."
---

Payload size limits are an essential functionality for ensuring optimal performance and reliability of the system. They safeguard system resources by preventing oversized payloads from impacting API performance and ensure efficient processing of event triggers.
Expand Down Expand Up @@ -80,4 +80,3 @@ Attachments do not count towards the 512KB payload limit
- [Trigger Event](/api-reference/events/trigger-event) - Single event trigger API
- [Bulk Trigger Event](/api-reference/events/bulk-trigger-event) - Batch event trigger API
- [Broadcast Event](/api-reference/events/broadcast-event-to-all) - Broadcast to all subscribers

2 changes: 1 addition & 1 deletion content/docs/api-reference/rate-limiting.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Rate Limiting'
pageTitle: 'API Rate Limiting'
pageTitle: "API Rate Limiting"
description: "In this page you can learn about how rate limiting works with Novu's API"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Subscriber schema
pageTitle: "Subscriber schema API Reference (Subscribers)"
description: "Reference the Novu subscriber object schema. Explore all fields, data types, and descriptions for the Subscriber resource used in the Novu API."
---

### Subscriber
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Subscriber schema
pageTitle: "Subscriber schema Model API Reference (Subscribers)"
description: "Reference the Novu subscriber schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Subscriber
Expand Down
2 changes: 2 additions & 0 deletions content/docs/api-reference/topics/topic-schema.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Topic schema
pageTitle: "Topic schema API Reference (Topics)"
description: "Reference the Novu topic object schema. Explore all fields, data types, and descriptions for the Topic resource used in the Novu API."
---

### Topic
Expand Down
2 changes: 2 additions & 0 deletions content/docs/api-reference/topics/topic-schema.model.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Topic schema
pageTitle: "Topic schema Model API Reference (Topics)"
description: "Reference the Novu topic schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Topic
Expand Down
2 changes: 2 additions & 0 deletions content/docs/api-reference/workflows/workflow-schema.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Workflow schema
pageTitle: "Workflow schema API Reference (Workflows)"
description: "Reference the Novu workflow schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Workflow
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Workflow schema
pageTitle: "Workflow schema Model API Reference (Workflows)"
description: "Reference the Novu workflow schema used in API requests and responses. Review fields, data types, and object structure for this resource."
---

### Workflow
Expand Down
2 changes: 1 addition & 1 deletion content/docs/community/add-a-new-provider.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Add a new provider'
pageTitle: "Add a new provider"
title: 'Add a New Provider'
description: 'Steps to add a new provider to Novu'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/community/changelog.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Changelog'
pageTitle: "Novu Community Changelog - community documentation and contribution guide for Novu"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Retitle this around releases rather than contribution guidance.

Line 2 reads like a community landing page, but this doc is primarily a changelog. That makes the tab/search title less accurate than the actual page content.

Suggested wording
-pageTitle: "Novu Community Changelog - community documentation and contribution guide for Novu"
+pageTitle: "Novu Community Changelog - product updates, releases, and bug fixes"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
pageTitle: "Novu Community Changelog - community documentation and contribution guide for Novu"
pageTitle: "Novu Community Changelog - product updates, releases, and bug fixes"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/docs/community/changelog.mdx` at line 2, The pageTitle value "Novu
Community Changelog - community documentation and contribution guide for Novu"
is misleading for a changelog page; update the pageTitle string to focus on
releases/changelog (e.g., include "Releases", "Changelog", or a date range) so
the tab/search title reflects the document's purpose—locate the pageTitle
assignment in this file and replace it with a concise releases-focused title
such as "Novu Releases & Changelog" or similar.

title: 'Changelog'
description: "See the most recent changes and learn about how to shape Novu's future"
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/community/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Community Overview'
pageTitle: "Community Overview - community documentation and contribution guide for Novu"
title: 'Community Overview'
description: 'Get started and get involved with the Novu Project'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/community/roadmap.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Roadmap'
pageTitle: "Novu Product Roadmap — Upcoming Features"
title: 'Roadmap'
description: 'Learn about our roadmap'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/community/run-in-local-machine.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Run Novu in local machine'
pageTitle: "Run Novu in local machine"
title: 'Run Novu in local machine'
description: 'Prerequisites and steps to run Novu in local machine. Learn how to set up Novu on your local environment for testing and development.'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/community/self-hosted-and-novu-cloud.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Self-Hosted and Novu Cloud'
pageTitle: "Self-Hosted and Novu Cloud"
title: 'Self-Hosted and Novu Cloud'
description: 'Understand the difference between Self-Hosted and Novu Cloud'
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Deploy with Docker'
pageTitle: "Deploy with Docker - self-hosting setup and operations guide for Novu deployments"
title: 'Deploy with Docker'
description: 'Learn how to deploy Novu with Docker'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/community/self-hosting-novu/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Overview'
pageTitle: "Self-Hosting Novu Overview"
title: 'Overview'
description: 'Self-hosting Novu provides full control and flexibility over your notification infrastructure, with specific system requirements for optimal performance across VMs, Redis, MongoDB, FerretDB, and S3 storage.'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/community/self-hosting-novu/telemetry.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Telemetry'
pageTitle: "Telemetry - self-hosting setup and operations guide for Novu deployments"
title: 'Telemetry'
description: "Learn about Novu's telemetry data collection and how to configure it"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Migrating from v0 Web UI to v2 Dashboard"
pageTitle: 'Migrate from v0 Web UI to v2 Dashboard'
title: "Migrate from v0 to v2 Dashboard"
Comment on lines +2 to +3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Inconsistency between pageTitle and title.

The pageTitle mentions "Web UI" while the title omits it. If intentional (shorter title for navigation), this is fine. Otherwise, consider aligning them for consistency.

Option to align if unintentional
 pageTitle: 'Migrate from v0 Web UI to v2 Dashboard'
-title: "Migrate from v0 to v2 Dashboard"
+title: "Migrate from v0 Web UI to v2 Dashboard"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
pageTitle: 'Migrate from v0 Web UI to v2 Dashboard'
title: "Migrate from v0 to v2 Dashboard"
pageTitle: 'Migrate from v0 Web UI to v2 Dashboard'
title: "Migrate from v0 Web UI to v2 Dashboard"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@content/docs/community/self-hosting-novu/v0-to-v2-migration.mdx` around lines
2 - 3, The page metadata has an inconsistency: the frontmatter key pageTitle is
"Migrate from v0 Web UI to v2 Dashboard" while title is "Migrate from v0 to v2
Dashboard"; decide whether the shorter title is intentional, then update one to
match the other for consistency—either change pageTitle to "Migrate from v0 to
v2 Dashboard" or change title to include "Web UI"—and ensure the keys pageTitle
and title in this document are aligned accordingly.

description: "A guide to help you migrate from Novu self-hosted v0 to v2"
---

Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/chat-channel.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Chat Channel'
pageTitle: "Novu Framework Chat Channel"
title: 'Chat'
description: 'Learn the process of configuring and using chat providers with Novu'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/content/react-email.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'React Email'
pageTitle: "React Email - email content template integration guide for Novu Framework channels"
title: 'React Email'
description: 'Learn how to use React Email to build beautiful email templates'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/content/remix-react-email.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Remix & React Email'
pageTitle: "Remix & React Email - email content template integration guide for Novu Framework channels"
title: 'Remix & React Email'
description: 'Learn how to integrate React Email with Novu Framework in a Remix application'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/content/svelte-email.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Svelte Email'
pageTitle: "Svelte Email - email content template integration guide for Novu Framework channels"
title: 'Svelte Email'
description: 'Learn how to use Svelte Email to build beautiful email templates'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/content/vue-email.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Vue Email'
pageTitle: "Vue Email - email content template integration guide for Novu Framework channels"
title: 'Vue Email'
description: 'Learn how to use Vue Email to build beautiful email templates'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/controls.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Controls'
pageTitle: "Novu Framework Controls"
title: 'Controls'
description: 'Learn how to use Controls in your notification workflows'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/custom.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Custom Action Step'
pageTitle: "Novu Framework Custom Action Step"
title: 'Custom Step'
description: 'Used to execute any custom code as a step in the workflow.'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/deployment/production.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Production Deployment Guide'
pageTitle: 'Going to Production'
pageTitle: "Going to Production - production deployment and operations guide for Novu Framework"
description: 'Learn how to deploy your Novu Framework application to production including networking, security, and HMAC verification setup.'
---

Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/email-channel.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Email Channel'
pageTitle: "Novu Framework Email Channel"
title: 'Email'
description: 'Learn how to configure the Email channel'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/in-app-channel.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'In-App Channel'
pageTitle: "Novu Framework In-App Channel"
title: 'In-App'
description: 'Learn how to configure the In-App channel'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Novu Framework Overview'
pageTitle: "Novu Framework Overview - overview of Novu Framework architecture, concepts, and setup"
title: 'Overview'
description: "Learn how to extend Novu's capabilities by building custom notification workflows with code using the Novu Framework."
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Introduction to Novu Framework'
pageTitle: "Novu Framework Introduction - introduction to building notification workflows with Novu Framework"
title: 'Introduction'
description: 'Discover how the Novu Framework empowers you to build, customize, and manage advanced notification workflows with a mix of code and no-code capabilities.'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/push-channel.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Push Channel'
pageTitle: "Novu Framework Push Channel"
title: 'Push'
description: 'Learn how to configure the Push channel'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/quickstart/express.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Express Quickstart'
pageTitle: "Express.js Framework Quickstart Guide"
title: 'Express'
description: 'Get started with Novu Framework in an Express application'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/quickstart/h3.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'H3 Quickstart'
pageTitle: "H3 Framework Quickstart Guide"
title: 'H3'
description: 'Get started with Novu Framework in an H3 application'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/quickstart/lambda.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'AWS Lambda Quickstart'
pageTitle: "AWS Lambda Framework Quickstart Guide"
title: 'AWS Lambda'
description: 'Get started with Novu Framework in an AWS Lambda function'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/quickstart/nestjs.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'NestJS Quickstart'
pageTitle: "NestJS Framework Quickstart Guide"
title: 'NestJS'
description: 'Get started with Novu Framework in a NestJS application'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/quickstart/nextjs.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Next.js Quickstart'
pageTitle: "Next.js Framework Quickstart Guide"
title: 'Next.js'
description: 'Get started with Novu Framework in a Next.js application'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/quickstart/nuxt.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Nuxt Quickstart'
pageTitle: "Nuxt Framework Quickstart Guide"
title: 'Nuxt'
description: 'Get started with Novu Framework in a Nuxt application'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/quickstart/remix.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'Remix Quickstart'
pageTitle: "Remix Framework Quickstart Guide"
title: 'Remix'
description: 'Get started with Novu Framework in a Remix application'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/quickstart/svelte.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
pageTitle: 'SvelteKit Quickstart'
pageTitle: "SvelteKit Framework Quickstart Guide"
title: 'SvelteKit'
description: 'Get started with Novu Framework in a SvelteKit application'
---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/framework/schema/class-validator.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Class Validator"
pageTitle: "Class Validator"
pageTitle: "Class Validator - schema validation guide for Novu Framework workflow payloads"
description: "Integrate Class Validator with your notification workflows"
---

Expand Down
Loading
Loading