Update docs url to env var (supabase#38772)

* Update Supabase docs URLs to use env variable

Co-authored-by: a <[email protected]>

* Refactor: Use DOCS_URL constant for documentation links

This change centralizes documentation links using a new DOCS_URL constant, improving maintainability and consistency.

Co-authored-by: a <[email protected]>

* Refactor: Use DOCS_URL constant for all documentation links

This change replaces hardcoded documentation URLs with a centralized constant, improving maintainability and consistency.

Co-authored-by: a <[email protected]>

* replace more instances

* ci: Autofix updates from GitHub workflow

* remaining instances

* fix duplicate useRouter

---------

Co-authored-by: Cursor Agent <[email protected]>
Co-authored-by: alaister <[email protected]>

Author: alaister

apps/studio/components/grid/components/grid/Grid.utils.tsx

@@ -11,6 +11,7 @@ import { tableRowKeys } from 'data/table-rows/keys'
 import { useTableRowUpdateMutation } from 'data/table-rows/table-row-update-mutation'
 import type { TableRowsData } from 'data/table-rows/table-rows-query'
 import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
+import { DOCS_URL } from 'lib/constants'
 import { useGetImpersonatedRoleState } from 'state/role-impersonation-state'
 import { useTableEditorTableStateSnapshot } from 'state/table-editor-table'
 import { Dictionary } from 'types'
@@ -115,7 +116,7 @@ export function useOnRowsChange(rows: SupaRow[]) {
                 each row before updating or deleting the row.
               </p>
               <div className="mt-3">
-                <DocsButton href="https://supabase.com/docs/guides/database/tables#primary-keys" />
+                <DocsButton href={`${DOCS_URL}/guides/database/tables#primary-keys`} />
               </div>
             </div>
           ),

apps/studio/components/grid/components/header/Header.tsx

@@ -17,6 +17,7 @@ import { useSendEventMutation } from 'data/telemetry/send-event-mutation'
 import { useAsyncCheckPermissions } from 'hooks/misc/useCheckPermissions'
 import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
 import { useSelectedProjectQuery } from 'hooks/misc/useSelectedProject'
+import { DOCS_URL } from 'lib/constants'
 import { RoleImpersonationState } from 'lib/role-impersonation'
 import {
   useRoleImpersonationStateSnapshot,
@@ -47,7 +48,7 @@ export const MAX_EXPORT_ROW_COUNT_MESSAGE = (
   <>
     Sorry! We're unable to support exporting row counts larger than $
     {MAX_EXPORT_ROW_COUNT.toLocaleString()} at the moment. Alternatively, you may consider using
-    <Link href="https://supabase.com/docs/reference/cli/supabase-db-dump" target="_blank">
+    <Link href={`${DOCS_URL}/reference/cli/supabase-db-dump`} target="_blank">
       pg_dump
     </Link>{' '}
     via our CLI instead.

apps/studio/components/interfaces/App/FeaturePreview/Branching2Preview.tsx

@@ -1,7 +1,7 @@
 import Image from 'next/image'
 
 import { InlineLink } from 'components/ui/InlineLink'
-import { BASE_PATH } from 'lib/constants'
+import { BASE_PATH, DOCS_URL } from 'lib/constants'
 
 export const Branching2Preview = () => {
   return (
@@ -16,7 +16,7 @@ export const Branching2Preview = () => {
       <p className="text-sm text-foreground-light mb-4">
         Create branches, review changes, and merge back into production all through the dashboard.
         Read the below limitations and our{' '}
-        <InlineLink href="https://supabase.com/docs/guides/platform/branching">
+        <InlineLink href={`${DOCS_URL}/guides/platform/branching`}>
           branching documentation
         </InlineLink>{' '}
         before opting in.

apps/studio/components/interfaces/App/FeaturePreview/CLSPreview.tsx

@@ -3,7 +3,7 @@ import Image from 'next/image'
 import { useParams } from 'common'
 import { Markdown } from 'components/interfaces/Markdown'
 import { InlineLink } from 'components/ui/InlineLink'
-import { BASE_PATH } from 'lib/constants'
+import { BASE_PATH, DOCS_URL } from 'lib/constants'
 import { AlertDescription_Shadcn_, AlertTitle_Shadcn_, Alert_Shadcn_, WarningIcon } from 'ui'
 
 export const CLSPreview = () => {
@@ -14,11 +14,11 @@ export const CLSPreview = () => {
       <div className="mb-4 flex flex-col gap-y-2">
         <Markdown
           className="text-foreground-light max-w-full"
-          content={`[Postgres Column-Level Privileges](https://supabase.com/docs/guides/auth/column-level-security) is a feature of Postgres that allows you to grant or revoke privileges on tables and columns based on user roles.`}
+          content={`[Postgres Column-Level Privileges](${DOCS_URL}/guides/auth/column-level-security) is a feature of Postgres that allows you to grant or revoke privileges on tables and columns based on user roles.`}
         />
         <Markdown
           className="text-foreground-light max-w-full"
-          content={`This is an advanced feature and should be used with caution. Unless you have a very specific use case, we recommend just using [Row-Level Security](https://supabase.com/docs/guides/auth/row-level-security).`}
+          content={`This is an advanced feature and should be used with caution. Unless you have a very specific use case, we recommend just using [Row-Level Security](${DOCS_URL}/guides/auth/row-level-security).`}
         />
         <Alert_Shadcn_ variant="warning" className="mt-2">
           <WarningIcon />

apps/studio/components/interfaces/Auth/AuthProvidersForm/AuthAlert.tsx

@@ -2,6 +2,7 @@ import { ExternalLink } from 'lucide-react'
 import Link from 'next/link'
 
 import { useParams } from 'common'
+import { DOCS_URL } from 'lib/constants'
 import {
   Alert_Shadcn_,
   AlertDescription_Shadcn_,
@@ -31,7 +32,7 @@ export const AuthAlert = ({
             below. Developers using this provider should move over to the new provider. Please refer
             to our{' '}
             <a
-              href="https://supabase.com/docs/guides/auth/social-login/auth-slack"
+              href={`${DOCS_URL}/guides/auth/social-login/auth-slack`}
               className="underline"
               target="_blank"
             >

apps/studio/components/interfaces/Auth/AuthProvidersForm/AuthProvidersForm.tsx

@@ -10,6 +10,7 @@ import {
 import { ResourceList } from 'components/ui/Resource/ResourceList'
 import { HorizontalShimmerWithIcon } from 'components/ui/Shimmers/Shimmers'
 import { useAuthConfigQuery } from 'data/auth/auth-config-query'
+import { DOCS_URL } from 'lib/constants'
 import {
   Alert_Shadcn_,
   AlertDescription_Shadcn_,
@@ -53,7 +54,7 @@ export const AuthProvidersForm = () => {
                   to more than an hour. It is recommended to set this value to less than an hour.
                 </p>
                 <Button asChild type="default" className="w-min" icon={<ExternalLink />}>
-                  <Link href="https://supabase.com/docs/guides/platform/going-into-prod#security">
+                  <Link href={`${DOCS_URL}/guides/platform/going-into-prod#security`}>
                     View security recommendations
                   </Link>
                 </Button>

apps/studio/components/interfaces/Auth/AuthProvidersFormValidation.tsx

@@ -1,5 +1,6 @@
 import { NO_REQUIRED_CHARACTERS, urlRegex } from 'components/interfaces/Auth/Auth.constants'
 import { ProjectAuthConfigData } from 'data/auth/auth-config-query'
+import { DOCS_URL } from 'lib/constants'
 import { boolean, number, object, string } from 'yup'
 
 const parseBase64URL = (b64url: string) => {
@@ -12,7 +13,7 @@ const PROVIDER_EMAIL = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Email',
-  link: 'https://supabase.com/docs/guides/auth/passwords',
+  link: `${DOCS_URL}/guides/auth/passwords`,
   properties: {
     EXTERNAL_EMAIL_ENABLED: {
       title: 'Enable Email provider',
@@ -95,7 +96,7 @@ const PROVIDER_EMAIL = {
   misc: {
     iconKey: 'email-icon2',
     helper: `To complete setup, add this authorisation callback URL to your app's configuration in the Apple Developer Console.
-            [Learn more](https://supabase.com/docs/guides/auth/social-login/auth-apple#configure-your-services-id)`,
+[Learn more](${DOCS_URL}/guides/auth/social-login/auth-apple#configure-your-services-id)`,
   },
 }
 
@@ -217,7 +218,7 @@ export const PROVIDER_PHONE = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Phone',
-  link: 'https://supabase.com/docs/guides/auth/phone-login',
+  link: `${DOCS_URL}/guides/auth/phone-login`,
   properties: {
     EXTERNAL_PHONE_ENABLED: {
       title: 'Enable Phone provider',
@@ -418,15 +419,15 @@ export const PROVIDER_PHONE = {
   misc: {
     iconKey: 'phone-icon4',
     helper: `To complete setup, add this authorisation callback URL to your app's configuration in the Apple Developer Console.
-            [Learn more](https://supabase.com/docs/guides/auth/social-login/auth-apple#configure-your-services-id)`,
+[Learn more](${DOCS_URL}/guides/auth/social-login/auth-apple#configure-your-services-id)`,
   },
 }
 
 const EXTERNAL_PROVIDER_APPLE = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Apple',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-apple',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-apple`,
   properties: {
     EXTERNAL_APPLE_ENABLED: {
       title: 'Enable Sign in with Apple',
@@ -441,7 +442,7 @@ const EXTERNAL_PROVIDER_APPLE = {
     },
     EXTERNAL_APPLE_SECRET: {
       title: 'Secret Key (for OAuth)',
-      description: `Secret key used in the OAuth flow. [Learn more](https://supabase.com/docs/guides/auth/social-login/auth-apple#generate-a-client_secret)`,
+      description: `Secret key used in the OAuth flow. [Learn more](${DOCS_URL}/guides/auth/social-login/auth-apple#generate-a-client_secret)`,
       type: 'string',
       isSecret: true,
     },
@@ -527,7 +528,7 @@ const EXTERNAL_PROVIDER_APPLE = {
     iconKey: 'apple-icon',
     requiresRedirect: true,
     helper: `Register this callback URL when using Sign in with Apple on the web in the Apple Developer Center.
-            [Learn more](https://supabase.com/docs/guides/auth/social-login/auth-apple#configure-your-services-id)`,
+[Learn more](${DOCS_URL}/guides/auth/social-login/auth-apple#configure-your-services-id)`,
     alert: {
       title: `Apple OAuth secret keys expire every 6 months`,
       description: `A new secret should be generated every 6 months, otherwise users on the web will not be able to sign in.`,
@@ -539,7 +540,7 @@ const EXTERNAL_PROVIDER_AZURE = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Azure',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-azure',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-azure`,
   properties: {
     EXTERNAL_AZURE_ENABLED: {
       title: 'Azure enabled',
@@ -553,7 +554,7 @@ const EXTERNAL_PROVIDER_AZURE = {
     EXTERNAL_AZURE_SECRET: {
       // [TODO] Change docs
       title: 'Secret Value',
-      description: `Enter the data from Value, not the Secret ID. [Learn more](https://supabase.com/docs/guides/auth/social-login/auth-azure#obtain-a-secret-id)`,
+      description: `Enter the data from Value, not the Secret ID. [Learn more](${DOCS_URL}/guides/auth/social-login/auth-azure#obtain-a-secret-id)`,
       type: 'string',
       isSecret: true,
     },
@@ -588,7 +589,7 @@ const EXTERNAL_PROVIDER_BITBUCKET = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Bitbucket',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-bitbucket',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-bitbucket`,
   properties: {
     EXTERNAL_BITBUCKET_ENABLED: {
       title: 'Bitbucket enabled',
@@ -627,7 +628,7 @@ const EXTERNAL_PROVIDER_DISCORD = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Discord',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-discord?',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-discord?`,
   properties: {
     EXTERNAL_DISCORD_ENABLED: {
       title: 'Discord enabled',
@@ -666,7 +667,7 @@ const EXTERNAL_PROVIDER_FACEBOOK = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Facebook',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-facebook',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-facebook`,
   properties: {
     EXTERNAL_FACEBOOK_ENABLED: {
       title: 'Facebook enabled',
@@ -705,7 +706,7 @@ const EXTERNAL_PROVIDER_FIGMA = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Figma',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-figma',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-figma`,
   properties: {
     EXTERNAL_FIGMA_ENABLED: {
       title: 'Figma enabled',
@@ -744,7 +745,7 @@ const EXTERNAL_PROVIDER_GITHUB = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'GitHub',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-github',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-github`,
   properties: {
     EXTERNAL_GITHUB_ENABLED: {
       title: 'GitHub enabled',
@@ -783,7 +784,7 @@ const EXTERNAL_PROVIDER_GITLAB = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'GitLab',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-gitlab',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-gitlab`,
   properties: {
     EXTERNAL_GITLAB_ENABLED: {
       title: 'GitLab enabled',
@@ -830,7 +831,7 @@ const EXTERNAL_PROVIDER_GOOGLE = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Google',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-google',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-google`,
   properties: {
     EXTERNAL_GOOGLE_ENABLED: {
       title: 'Enable Sign in with Google',
@@ -884,15 +885,15 @@ const EXTERNAL_PROVIDER_GOOGLE = {
     iconKey: 'google-icon',
     requiresRedirect: true,
     helper: `Register this callback URL when using Sign-in with Google on the web using OAuth.
-            [Learn more](https://supabase.com/docs/guides/auth/social-login/auth-google#configure-your-services-id)`,
+[Learn more](${DOCS_URL}/guides/auth/social-login/auth-google#configure-your-services-id)`,
   },
 }
 
 const EXTERNAL_PROVIDER_KAKAO = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Kakao',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-kakao',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-kakao`,
   properties: {
     EXTERNAL_KAKAO_ENABLED: {
       title: 'Kakao enabled',
@@ -934,7 +935,7 @@ const EXTERNAL_PROVIDER_KEYCLOAK = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'KeyCloak',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-keycloak',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-keycloak`,
   properties: {
     EXTERNAL_KEYCLOAK_ENABLED: {
       title: 'Keycloak enabled',
@@ -985,7 +986,7 @@ const EXTERNAL_PROVIDER_LINKEDIN_OIDC = {
   type: 'object',
   key: 'linkedin_oidc',
   title: 'LinkedIn (OIDC)',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-linkedin',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-linkedin`,
   properties: {
     EXTERNAL_LINKEDIN_OIDC_ENABLED: {
       title: 'LinkedIn enabled',
@@ -1024,7 +1025,7 @@ const EXTERNAL_PROVIDER_NOTION = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Notion',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-notion',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-notion`,
   properties: {
     EXTERNAL_NOTION_ENABLED: {
       title: 'Notion enabled',
@@ -1063,7 +1064,7 @@ const EXTERNAL_PROVIDER_TWITCH = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Twitch',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-twitch',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-twitch`,
   properties: {
     EXTERNAL_TWITCH_ENABLED: {
       title: 'Twitch enabled',
@@ -1102,7 +1103,7 @@ const EXTERNAL_PROVIDER_TWITTER = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Twitter',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-twitter',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-twitter`,
   properties: {
     EXTERNAL_TWITTER_ENABLED: {
       title: 'Twitter enabled',
@@ -1141,7 +1142,7 @@ const EXTERNAL_PROVIDER_SLACK = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Slack (Deprecated)',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-slack',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-slack`,
   properties: {
     EXTERNAL_SLACK_ENABLED: {
       title: 'Slack enabled',
@@ -1181,7 +1182,7 @@ const EXTERNAL_PROVIDER_SLACK_OIDC = {
   type: 'object',
   title: 'Slack (OIDC)',
   key: 'slack_oidc',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-slack',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-slack`,
   properties: {
     EXTERNAL_SLACK_OIDC_ENABLED: {
       title: 'Slack enabled',
@@ -1220,7 +1221,7 @@ const EXTERNAL_PROVIDER_SPOTIFY = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Spotify',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-spotify',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-spotify`,
   properties: {
     EXTERNAL_SPOTIFY_ENABLED: {
       title: 'Spotify enabled',
@@ -1259,7 +1260,7 @@ const EXTERNAL_PROVIDER_WORKOS = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'WorkOS',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-workos',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-workos`,
   properties: {
     EXTERNAL_WORKOS_ENABLED: {
       title: 'WorkOS enabled',
@@ -1309,7 +1310,7 @@ const EXTERNAL_PROVIDER_ZOOM = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Zoom',
-  link: 'https://supabase.com/docs/guides/auth/social-login/auth-zoom',
+  link: `${DOCS_URL}/guides/auth/social-login/auth-zoom`,
   properties: {
     EXTERNAL_ZOOM_ENABLED: {
       title: 'Zoom enabled',
@@ -1348,12 +1349,11 @@ const PROVIDER_SAML = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'SAML 2.0',
-  link: 'https://supabase.com/docs/guides/auth/enterprise-sso/auth-sso-saml',
+  link: `${DOCS_URL}/guides/auth/enterprise-sso/auth-sso-saml`,
   properties: {
     SAML_ENABLED: {
       title: 'Enable SAML 2.0 Single Sign-on',
-      description:
-        'You will need to use the [Supabase CLI](https://supabase.com/docs/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to set up SAML after enabling it',
+      description: `You will need to use the [Supabase CLI](${DOCS_URL}/guides/auth/sso/auth-sso-saml#managing-saml-20-connections) to set up SAML after enabling it`,
       type: 'boolean',
     },
     SAML_EXTERNAL_URL: {
@@ -1385,7 +1385,7 @@ const PROVIDER_WEB3 = {
   $schema: JSON_SCHEMA_VERSION,
   type: 'object',
   title: 'Web3 Wallet',
-  link: 'https://supabase.com/docs/guides/auth/auth-web3',
+  link: `${DOCS_URL}/guides/auth/auth-web3`,
   properties: {
     EXTERNAL_WEB3_ETHEREUM_ENABLED: {
       title: 'Enable Sign in with Ethereum',