diff --git a/docs/README.md b/docs/README.md index 6b53b36c3..3c233c827 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,8 +6,8 @@ Here you can find the documentation for shelf. - [Getting Started](./get-started.md) - Instructions for how to get started with Shelf. -- [Response and Error handling](../handling-errors.md) - Guide on how to handle responses and errors in actions/loaders and services -- [Shelf Config file](../shelf-config.md) - Shelf configuration file +- [Response and Error handling](./handling-errors.md) - Guide on how to handle responses and errors in actions/loaders and services +- [Shelf Config file](./shelf-config.md) - Shelf configuration file - [Asset Search](./asset-search.md) - Asset search via Prisma Full text search - [Docker](./docker.md) - Run shelf via docker - [Contributing](../CONTRIBUTING.md) - Contributing to Shelf. diff --git a/docs/shelf.config.ts.md b/docs/shelf.config.ts.md index 95507a574..a9b564345 100644 --- a/docs/shelf.config.ts.md +++ b/docs/shelf.config.ts.md @@ -8,7 +8,7 @@ import { ENABLE_PREMIUM_FEATURES } from "~/utils"; import { Config } from "./types"; export const config: Config = { - sendOnboardingEmail: true, + sendOnboardingEmail: SEND_ONBOARDING_EMAIL || false, enablePremiumFeatures: ENABLE_PREMIUM_FEATURES || false, }; ``` @@ -16,6 +16,7 @@ export const config: Config = { ## sendOnboardingEmail This flag allows you to choose whether the onboarding email will be sent to new users. Email is being sent within the action of `routes/_welcome+/onboarding.tsx` +Default value is false. If you want to override it you can use the env variable `SEND_ONBOARDING_EMAIL` ```ts //remix.config.ts