Merge pull request #633 from novuhq/v2-docs

v2 docs preview

.eslintrc.json

@@ -0,0 +1,15 @@
+{
+  "extends": [
+    "eslint:recommended",
+    "plugin:mdx/recommended"
+  ],
+  // optional, if you want to lint code blocks at the same time
+  "settings": {
+    "mdx/code-blocks": false
+  },
+  "rules": {
+    "no-undef": "off",
+    "no-unused-expressions": "off",
+    "no-unused-vars": "off"
+  }
+}

.github/workflows/invalidate-echo-snippet.yml

@@ -7,13 +7,12 @@ on:
       - next
       - main
     paths:
-      - 'echo-terminal.js'
+      - "echo-terminal.js"
 
 jobs:
-    build:
-        runs-on: ubuntu-latest
-
-        steps:
-        - run: "curl -X GET https://purge.jsdelivr.net/gh/novuhq/docs/echo-terminal.min.js"
-        - run: "curl -X GET https://purge.jsdelivr.net/gh/novuhq/docs/echo-terminal.js"
-
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - run: "curl -X GET https://purge.jsdelivr.net/gh/novuhq/docs/echo-terminal.min.js"
+      - run: "curl -X GET https://purge.jsdelivr.net/gh/novuhq/docs/echo-terminal.js"

.prettierignore

@@ -1,4 +1,3 @@
 # Ignore all HTML files:
-**/*.mdx
 script.js
 hubspot.js

.speakeasy/workflow.yaml

@@ -1,12 +1,12 @@
 workflowVersion: 1.0.0
 speakeasyVersion: latest
 sources:
-    openapi-with-code-samples:
-        inputs:
-            - location: registry.speakeasyapi.dev/novu/novu/json-development:main
-        overlays:
-            - location: registry.speakeasyapi.dev/novu/novu/code-samples-typescript:main
-        output: ./openapi.json
-        registry:
-            location: registry.speakeasyapi.dev/novu/novu/openapi-with-code-samples
+  openapi-with-code-samples:
+    inputs:
+      - location: registry.speakeasyapi.dev/novu/novu/json-development:main
+    overlays:
+      - location: registry.speakeasyapi.dev/novu/novu/code-samples-typescript:main
+    output: ./openapi.json
+    registry:
+      location: registry.speakeasyapi.dev/novu/novu/openapi-with-code-samples
 targets: {}

README.md

@@ -55,7 +55,7 @@ First, install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) locall
 npm i -g mintlify
 ```
 
-__Note__: Please install Node.js (version 18 or higher) before proceeding.
+**Note**: Please install Node.js (version 18 or higher) before proceeding.
 
 Run the following command at the root of the documentation (where mint.json is) to preview the documentation changes
 

additional-resources/data-migrations.mdx

@@ -1,7 +1,7 @@
 ---
-title: 'Data Migrations'
-description: 'Learn how to update your database data through migrations.'
-icon: 'database'
+title: "Data Migrations"
+description: "Learn how to update your database data through migrations."
+icon: "database"
 ---
 
 On occasion, Novu may introduce features that require changes to the database schema or data.
@@ -25,15 +25,15 @@ Some features may have multiple migrations, in which case you will need to run e
 
 Below you will find a list of migrations introduced in previous versions of Novu, alongside the migration path to use in the script above.
 
-| Version | Feature | Migration Path(s) |
-| --- | --- | --- |
-| [v0.23](https://github.com/novuhq/novu/releases/tag/v0.23.0) | API keys encryption | `./encrypt-api-keys/encrypt-api-keys-migration.ts` |
-| [v0.18](https://github.com/novuhq/novu/releases/tag/v0.18.0) | Multi-Provider | `./integration-scheme-update/add-primary-priority-migration.ts`<br/>`./integration-scheme-update/add-integration-identifier-migration.ts` |
-| | Integration Store | `./novu-integrations/novu-integrations.migration.ts` |
-| [v0.16](https://github.com/novuhq/novu/releases/tag/v0.16.0) | In-App Integration | `./in-app-integration/in-app-integration.migration.ts` |
-| | Secure Flag Fix | `./secure-to-boolean/secure-to-boolean-migration.ts` |
-| [v0.15](https://github.com/novuhq/novu/releases/tag/v0.15.0) | Database TTL | `./expire-at/expire-at.migration.ts` |
-| [v0.12](https://github.com/novuhq/novu/releases/tag/v0.12.0) | Organization Invite Fix | `./normalize-users-email/normalize-users-email.migration.ts` |
-| [v0.9](https://github.com/novuhq/novu/releases/tag/v0.9.0) | Seen/Read Support | `./seen-read-support/seen-read-support.migration.ts` |
-| [v0.8](https://github.com/novuhq/novu/releases/tag/v0.8.0) | Secure Credentials | `./fcm-credentials/fcm-credentials-migration.ts`<br/>`./encrypt-credentials/encrypt-credentials-migration.ts` |
-| [v0.4](https://github.com/novuhq/novu/releases/tag/v0.4.0) | Change Promotion | `./changes-migration.ts` |
+| Version                                                      | Feature                 | Migration Path(s)                                                                                                                         |
+| ------------------------------------------------------------ | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
+| [v0.23](https://github.com/novuhq/novu/releases/tag/v0.23.0) | API keys encryption     | `./encrypt-api-keys/encrypt-api-keys-migration.ts`                                                                                        |
+| [v0.18](https://github.com/novuhq/novu/releases/tag/v0.18.0) | Multi-Provider          | `./integration-scheme-update/add-primary-priority-migration.ts`<br/>`./integration-scheme-update/add-integration-identifier-migration.ts` |
+|                                                              | Integration Store       | `./novu-integrations/novu-integrations.migration.ts`                                                                                      |
+| [v0.16](https://github.com/novuhq/novu/releases/tag/v0.16.0) | In-App Integration      | `./in-app-integration/in-app-integration.migration.ts`                                                                                    |
+|                                                              | Secure Flag Fix         | `./secure-to-boolean/secure-to-boolean-migration.ts`                                                                                      |
+| [v0.15](https://github.com/novuhq/novu/releases/tag/v0.15.0) | Database TTL            | `./expire-at/expire-at.migration.ts`                                                                                                      |
+| [v0.12](https://github.com/novuhq/novu/releases/tag/v0.12.0) | Organization Invite Fix | `./normalize-users-email/normalize-users-email.migration.ts`                                                                              |
+| [v0.9](https://github.com/novuhq/novu/releases/tag/v0.9.0)   | Seen/Read Support       | `./seen-read-support/seen-read-support.migration.ts`                                                                                      |
+| [v0.8](https://github.com/novuhq/novu/releases/tag/v0.8.0)   | Secure Credentials      | `./fcm-credentials/fcm-credentials-migration.ts`<br/>`./encrypt-credentials/encrypt-credentials-migration.ts`                             |
+| [v0.4](https://github.com/novuhq/novu/releases/tag/v0.4.0)   | Change Promotion        | `./changes-migration.ts`                                                                                                                  |