From b0cc46f53eb226d99eb0a6e7a9f00fcf80c16c5d Mon Sep 17 00:00:00 2001 From: Ritesh Ghosh Date: Sun, 25 May 2025 23:59:20 +0530 Subject: [PATCH] refactor: add docs link & more description for `ANIWATCH_API_DEPLOYMENT_ENV` env --- src/config/env.ts | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/config/env.ts b/src/config/env.ts index 8263b13..2935084 100644 --- a/src/config/env.ts +++ b/src/config/env.ts @@ -47,7 +47,8 @@ export const env = cleanEnv(process.env, { choices: API_DEPLOYMENT_ENVIRONMENTS, default: DeploymentEnv.NODEJS, example: DeploymentEnv.VERCEL, - desc: "The deployment environment of the Aniwatch API. It must be set incase of serverless deployments, can lead to issues if not set.", + desc: "The deployment environment of the Aniwatch API. It must be set incase of serverless deployments, otherwise you may run into weird issues.", + docs: "https://github.com/ghoshRitesh12/aniwatch-api/blob/main/.env.example#L21", }), ANIWATCH_API_HOSTNAME: str({ @@ -61,7 +62,7 @@ export const env = cleanEnv(process.env, { default: undefined, example: "rediss://default:your-secure-password@your-redis-instance-name.provider.com:6379", - desc: "This env is optional by default and can be set to utilize Redis caching functionality. It has to be a valid connection URL.", + desc: "This env is optional by default and can be set to utilize Redis caching functionality. It has to be a valid connection URL; otherwise, the Redis client can throw unexpected errors", }), ANIWATCH_API_S_MAXAGE: num({