Merge pull request #878 from novuhq/fix/concepts_pages_part_02

fix: topics, environments, preferences, tenants

Author: jainpawan21

content/docs/platform/concepts/endpoint.mdx

@@ -12,32 +12,32 @@ Use the development environment to test new notification workflows, validate cha
 
 ## Production Environment
 
-The production environment is your live environment where notifications are sent to real users.
+The production environment is your live environment where notifications are sent to real users. Use the production environment for production use cases, and other environments for non-production use cases.
 
 ## Custom Environments
 
-<Callout type="info">Custom environments are available in Business and Enterprise plans</Callout>
+<Callout type="info">Custom environments are available in Team and Enterprise plans.</Callout>
 
 Create custom environments to match your development workflow:
 
-1. Go to the Environments page in your dashboard
-2. Create environments like `Staging` or `QA`
-3. Assign unique colors to easily distinguish between environments
-4. Sync changes between environments just like with development and production
-
-The sync process works the same way as between development and production environments.
+1. Go to the [Environments page](https://dashboard.novu.co/environments) in Novu dashboard
+2. Click on the `Create environment` button on the top right.
+3. A popup will appear. Enter names like `Staging` or `QA`.
+4. Assign unique colors to easily distinguish between environments.
+5. Click on `Create environment` button on the bottom right.
+6. New environment will be created and will be available in the environments list.
 
 ## What's Unique to Each Environment?
 
 Each environment maintains its own separate:
 
-- Subscriber list
-- Notification workflows
-- Message history
+- Subscribers
+- Topics
+- Workflows
+- Webhooks
+- Integrations
+- API keys (application identifier and secret key)
 - Activity feed
-- Integration settings
-- Notification feeds
-- Brand assets and settings
 
 ## Environment Credentials
 
@@ -46,6 +46,7 @@ Each environment has two unique identifiers:
 1. **Application Identifier**
 
    - Public ID for client-side apps
+   - Used with <Method href="/platform/inbox/overview">{`<Inbox />`}</Method>
    - Unique per environment
    - Safe to expose in frontend code
 
@@ -56,9 +57,18 @@ Each environment has two unique identifiers:
 
 **Best Practice**: Configure these credentials in your application based on the active environment, similar to how you manage other service credentials.
 
-## Promoting Changes to Production
+## Promoting workflows between environments
+
+One workflow can be synced to another environment using the `Sync Workflow` option in workflow actions. While syncing, Novu will give option to which environment to sync the workflow to. If workflow with same identifier is already present in the destination environment, it will be overwritten with the source workflow.
+
+Steps:
 
-You can move changes from development to production in two ways:
+1. Go to the [Workflows page](https://dashboard.novu.co/workflows) in Novu dashboard
+2. Click on the three dot menu in the workflow row
+3. If you have more than two environments, hover over the `Sync Workflow` option to see the destination environment, then click it.
+4. If you have only two environments, Click on the `Sync to <Environment Name>` option. Here `Environment Name` is the name of another environment.
+5. The workflow will be synced to the destination environment.
 
-1. Using the Dashboard's sync interface
-2. Using the Sync API in your CI/CD pipeline
+<Callout type="info">
+Currently, a single workflow can be synced to another environment.
+</Callout>

content/docs/platform/concepts/environments.mdx

@@ -14,34 +14,68 @@ Novu provides a way to store subscriber preferences. This allows subscribers, yo
 
 ## Workflow channel preferences
 
-When creating a new workflow, you can specify default preferences for your subscribers via code or in the Dashboard. These preferences will be used during notification delivery unless the subscriber overrides via the preferences page in `<Inbox/>`.
+Each workflow has its own channel preferences. By default, all channel preferences are enabled. If disabled, the subscriber will not receive notifications for that channel step.
 
-<img src="/images/preferences/preferences.png" alt="Preferences" className="rounded-lg border" />
+Steps to manage workflow channel preferences:
 
-## Subscriber channel preferences per workflow
+1. Go to the [Workflows page](https://dashboard.novu.co/workflows) in Novu dashboard
+2. Click the workflow you want to manage channel preferences for
+3. A node-based editor will appear. On the right side of the editor, click the `Configure channel preferences` option
+4. Click on the All Channels checkbox to enable or disable all channels for the workflow
+5. You will be able to change the preferences for only those steps which are present in the workflow. Non existing channel steps will be disabled.
+6. The `Mark as critical` toggle will make this workflow critical. Read more about [critical workflows](#critical-workflows)
+
+<Callout type="info">
+  If a workflow has only `in-app` and `email` steps, then it will have only `in-app` and `email` preferences.
+</Callout>
 
-`<Inbox/>` displays the available preferences per workflow, allowing subscribers to modify them for each channel. Critical workflows will be excluded from the list.
+![Workflow channel preferences](/images/concepts/preferences/workflow-channel-preferences.png)
 
-<img
-  src="/images/preferences/inbox-workflow-preferences.png"
-  alt="Inbox Workflow Preferences"
-  className="rounded-lg border w-[400px]"
-/>
+### Critical workflows
+
+In some cases, you don't want the subscriber to be able to unsubscribe from mandatory notifications such as Account Verification, Password Reset, etc...
 
-<Callout type="info">Inbox displays only channels used by the current workflow.</Callout>
+In those cases, you can mark a workflow as `critical` in the workflow channel preferences. Critical workflows are not displayed in subscriber preferences, so subscribers cannot change preferences for that workflow.
 
 ## Subscriber global preferences
 
 Subscribers can set global channel preferences, which override individual settings. For instance, if there are 10 workflows, and a subscriber wants to disable SMS notifications for all of them, they can do so with via global preferences.
 
-<img
-  src="/images/preferences/inbox-global-preferences.png"
-  alt="Inbox Global Preferences"
-  className="rounded-lg border w-[400px]"
-/>
+![Preferences](/images/inbox/[email protected])
 
-## Critical workflows
+## Subscriber channel preferences per workflow
 
-In some cases, you don't want the subscriber to be able to unsubscribe from mandatory notifications such as Account Verification, Password Reset, etc...
+For each workflow, subscriber has its own channel preferences. Subscriber can manage these preferences from the <Method href="/platform/inbox/react/components/preferences">{`<Inbox />`}{" "}</Method> Preferences view.
+
+![Subscriber channel preferences](/images/concepts/preferences/subscriber-workflow-preferences.png)
+
+<Callout type="info">Inbox displays only channels present in the current workflow.</Callout>
+
+## Priority of preferences
+
+Since there are three types of preferences, the priority order is as follows:
+
+Workflow channel preferences > Subscriber global preferences > Subscriber channel preferences per workflow
+
+Examples:
+
+1. If the `email` channel is disabled in workflow channel preferences, global and subscriber preferences are ignored, and subscribers will not receive email notifications for this workflow.
+2. If the `in-app` channel is enabled in workflow channel preferences but the workflow is marked as critical, subscribers cannot change their preferences and will always receive in-app notifications.
+3. If both `chat` and `email` channels are enabled in the workflow but `email` is disabled in subscriber global preferences, the subscriber will receive only chat notifications for this workflow.
+
+## Subscriber preferences APIs
+
+Subscriber preferences can be retrieved and updated using following APIs:
 
-In those cases you can mark a workflow as `critical` in the Dashboard. Critical workflow are not displayed in the subscriber preferences page.
+<Cards>
+  <Card
+    title="Retrieve subscriber preferences"
+    href="/api-reference/subscribers/retrieve-subscriber-preferences"
+    description="Retrieve subscriber preferences for a subscriber"
+  />
+  <Card
+    title="Update subscriber preferences"
+    href="/api-reference/subscribers/update-subscriber-preferences"
+    description="Update subscriber preferences for a subscriber"
+  />
+</Cards>

content/docs/platform/concepts/preferences.mdx

@@ -62,8 +62,8 @@ await novu.trigger({
   payload: {
     tenant: {
       id: tenantId,
-      name: "Acme Corp",
-      logo: "https://acme-corp.com/logo.png",
+      name: "Airbnb",
+      logo: "https://airbnb.com/logo.png",
       primaryColor: "red",
     }
   },
@@ -74,17 +74,15 @@ The tenant object will be available to use in the workflow editor as a variable
 
 - Content (use `{{payload.tenant.name}}` to display the tenant name in an email or any other channel)
 - Step Conditions (use `{{payload.tenant.id}}` to conditionally execute a step based on the tenant)
+- Use the Inbox [data object](/platform/inbox/react/components/inbox#data-object) to filter notifications by tenant.
 
-## FAQ
+## Frequently asked questions
 
-<Accordions>
+The following are the frequently asked questions about multi-tenancy in Novu.
 
-<Accordion title="Can I use a different delivery provider for each tenant?">
-  Currently we do not support using a different delivery provider for each tenant. You can reach out to [email protected] in case this is a feature required for your use case.
-</Accordion>
+### Can I use a different delivery provider for each tenant?
+Currently, we do not support using a different delivery provider for each tenant. You can reach out to [email protected] in case this is a feature required for your use case.
 
-<Accordion title="Can I specify different workflow preferences for each tenant?">
-  We don't support specifying different workflow preferences for each tenant. You can reach out to [email protected] in case this is a feature required for your use case.
-</Accordion>
+### Can I specify different workflow preferences for each tenant?
+We don't support specifying different workflow preferences for each tenant. You can reach out to [email protected] in case this is a feature required for your use case.
 
-</Accordions>