chore(repo): Update Typedoc links to fix temporary ignore warnings (#6846)

Co-authored-by: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com>

Author: SarahSoutoul

.changeset/empty-melons-beg.md

@@ -0,0 +1,11 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/backend': minor
+'@clerk/nextjs': minor
+'@clerk/shared': minor
+'@clerk/clerk-react': minor
+'@clerk/types': minor
+'@clerk/vue': minor
+---
+
+Udpate Tyepdoc links to fix temporary ignore warnings

.typedoc/custom-plugin.mjs

@@ -26,34 +26,34 @@ const FILES_WITHOUT_HEADINGS = [
  * Ideally this is a temporary solution until every one of these files are published in production and can be linked to.
  */
 const LINK_REPLACEMENTS = [
-  ['clerk-paginated-response', '/docs/references/javascript/types/clerk-paginated-response'],
+  ['clerk-paginated-response', '/docs/reference/javascript/types/clerk-paginated-response'],
   ['paginated-resources', '#paginated-resources'],
-  ['session-resource', '/docs/references/javascript/session'],
-  ['signed-in-session-resource', '/docs/references/javascript/session'],
-  ['sign-up-resource', '/docs/references/javascript/sign-up'],
-  ['user-resource', '/docs/references/javascript/user'],
-  ['session-status-claim', '/docs/references/javascript/types/session-status'],
-  ['user-organization-invitation-resource', '/docs/references/javascript/types/user-organization-invitation'],
-  ['organization-membership-resource', '/docs/references/javascript/types/organization-membership'],
-  ['organization-suggestion-resource', '/docs/references/javascript/types/organization-suggestion'],
-  ['organization-resource', '/docs/references/javascript/organization'],
-  ['organization-domain-resource', '/docs/references/javascript/types/organization-domain'],
-  ['organization-invitation-resource', '/docs/references/javascript/types/organization-invitation'],
-  ['organization-membership-request-resource', '/docs/references/javascript/types/organization-membership-request'],
-  ['session', '/docs/references/backend/types/backend-session'],
-  ['session-activity', '/docs/references/backend/types/backend-session-activity'],
-  ['organization', '/docs/references/backend/types/backend-organization'],
+  ['session-resource', '/docs/reference/javascript/session'],
+  ['signed-in-session-resource', '/docs/reference/javascript/session'],
+  ['sign-up-resource', '/docs/reference/javascript/sign-up'],
+  ['user-resource', '/docs/reference/javascript/user'],
+  ['session-status-claim', '/docs/reference/javascript/types/session-status'],
+  ['user-organization-invitation-resource', '/docs/reference/javascript/types/user-organization-invitation'],
+  ['organization-membership-resource', '/docs/reference/javascript/types/organization-membership'],
+  ['organization-suggestion-resource', '/docs/reference/javascript/types/organization-suggestion'],
+  ['organization-resource', '/docs/reference/javascript/organization'],
+  ['organization-domain-resource', '/docs/reference/javascript/types/organization-domain'],
+  ['organization-invitation-resource', '/docs/reference/javascript/types/organization-invitation'],
+  ['organization-membership-request-resource', '/docs/reference/javascript/types/organization-membership-request'],
+  ['session', '/docs/reference/backend/types/backend-session'],
+  ['session-activity', '/docs/reference/backend/types/backend-session-activity'],
+  ['organization', '/docs/reference/backend/types/backend-organization'],
   ['public-organization-data-json', '#public-organization-data-json'],
   ['organization-membership-public-user-data', '#organization-membership-public-user-data'],
-  ['identification-link', '/docs/references/backend/types/backend-identification-link'],
-  ['verification', '/docs/references/backend/types/backend-verification'],
-  ['email-address', '/docs/references/backend/types/backend-email-address'],
-  ['external-account', '/docs/references/backend/types/backend-external-account'],
-  ['phone-number', '/docs/references/backend/types/backend-phone-number'],
-  ['saml-account', '/docs/references/backend/types/backend-saml-account'],
-  ['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
+  ['identification-link', '/docs/reference/backend/types/backend-identification-link'],
+  ['verification', '/docs/reference/backend/types/backend-verification'],
+  ['email-address', '/docs/reference/backend/types/backend-email-address'],
+  ['external-account', '/docs/reference/backend/types/backend-external-account'],
+  ['phone-number', '/docs/reference/backend/types/backend-phone-number'],
+  ['saml-account', '/docs/reference/backend/types/backend-saml-account'],
+  ['web3-wallet', '/docs/reference/backend/types/backend-web3-wallet'],
   ['verify-token-options', '#verify-token-options'],
-  ['localization-resource', '/docs/customization/localization'],
+  ['localization-resource', '/docs/guides/customizing-clerk/localization'],
 ];
 
 /**
@@ -84,48 +84,48 @@ function getCatchAllReplacements() {
   return [
     {
       pattern: /\(setActiveParams\)/g,
-      replace: '([setActiveParams](/docs/references/javascript/types/set-active-params))',
+      replace: '([setActiveParams](/docs/reference/javascript/types/set-active-params))',
     },
     {
       pattern: /`LoadedClerk`/g,
-      replace: '[Clerk](/docs/references/javascript/clerk)',
+      replace: '[Clerk](/docs/reference/javascript/clerk)',
     },
     {
       pattern: /\(CreateOrganizationParams\)/g,
       replace: '([CreateOrganizationParams](#create-organization-params))',
     },
     {
       pattern: /\| `SignInResource` \|/,
-      replace: '| [SignInResource](/docs/references/javascript/sign-in) |',
+      replace: '| [SignInResource](/docs/reference/javascript/sign-in) |',
     },
     {
       pattern: /`OrganizationPrivateMetadata`/g,
       replace:
-        '[`OrganizationPrivateMetadata`](/docs/references/javascript/types/metadata#organization-private-metadata)',
+        '[`OrganizationPrivateMetadata`](/docs/reference/javascript/types/metadata#organization-private-metadata)',
     },
     {
       pattern: /OrganizationPublicMetadata/g,
-      replace: '[OrganizationPublicMetadata](/docs/references/javascript/types/metadata#organization-public-metadata)',
+      replace: '[OrganizationPublicMetadata](/docs/reference/javascript/types/metadata#organization-public-metadata)',
     },
     {
       pattern: /`OrganizationInvitationPrivateMetadata`/g,
       replace:
-        '[`OrganizationInvitationPrivateMetadata`](/docs/references/javascript/types/metadata#organization-invitation-private-metadata)',
+        '[`OrganizationInvitationPrivateMetadata`](/docs/reference/javascript/types/metadata#organization-invitation-private-metadata)',
     },
     {
       pattern: /`OrganizationInvitationPublicMetadata`/g,
       replace:
-        '[`OrganizationInvitationPublicMetadata`](/docs/references/javascript/types/metadata#organization-invitation-public-metadata)',
+        '[`OrganizationInvitationPublicMetadata`](/docs/reference/javascript/types/metadata#organization-invitation-public-metadata)',
     },
     {
       pattern: /`OrganizationMembershipPrivateMetadata`/g,
       replace:
-        '[`OrganizationMembershipPrivateMetadata`](/docs/references/javascript/types/metadata#organization-membership-private-metadata)',
+        '[`OrganizationMembershipPrivateMetadata`](/docs/reference/javascript/types/metadata#organization-membership-private-metadata)',
     },
     {
       pattern: /`OrganizationMembershipPublicMetadata`/g,
       replace:
-        '[`OrganizationMembershipPublicMetadata`](/docs/references/javascript/types/metadata#organization-membership-public-metadata)',
+        '[`OrganizationMembershipPublicMetadata`](/docs/reference/javascript/types/metadata#organization-membership-public-metadata)',
     },
     {
       /**

packages/backend/src/api/endpoints/InstanceApi.ts

@@ -52,7 +52,7 @@ type UpdateOrganizationSettingsParams = {
   adminDeleteEnabled?: boolean | null | undefined;
   domainsEnabled?: boolean | null | undefined;
   /**
-   * Specifies which [enrollment modes](https://clerk.com/docs/organizations/verified-domains#enrollment-mode) to enable for your Organization Domains.
+   * Specifies which [enrollment modes](https://clerk.com/docs/guides/organizations/verified-domains#enrollment-mode) to enable for your Organization Domains.
    *
    * @remarks Supported modes are 'automatic_invitation' & 'automatic_suggestion'.
    */

packages/backend/src/api/resources/AllowlistIdentifier.ts

@@ -11,7 +11,7 @@ export class AllowlistIdentifier {
      */
     readonly id: string,
     /**
-     * The [identifier](https://clerk.com/docs/authentication/configuration/sign-up-sign-in-options#identifiers) that was added to the allowlist.
+     * The identifier that was added to the allowlist.
      */
     readonly identifier: string,
     /**

packages/backend/src/api/resources/Client.ts

@@ -4,7 +4,7 @@ import type { ClientJSON } from './JSON';
 import { Session } from './Session';
 
 /**
- * The Backend `Client` object is similar to the [`Client`](https://clerk.com/docs/references/javascript/client) object as it holds information about the authenticated sessions in the current device. However, the Backend `Client` object is different from the `Client` object in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Clients#operation/GetClient) and is not directly accessible from the Frontend API.
+ * The Backend `Client` object is similar to the [`Client`](https://clerk.com/docs/reference/javascript/client) object as it holds information about the authenticated sessions in the current device. However, the Backend `Client` object is different from the `Client` object in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Clients#operation/GetClient) and is not directly accessible from the Frontend API.
  */
 export class Client {
   constructor(
@@ -13,23 +13,23 @@ export class Client {
      */
     readonly id: string,
     /**
-     * An array of [Session](https://clerk.com/docs/references/backend/types/backend-session){{ target: '_blank' }} IDs associated with the `Client`.
+     * An array of [Session](https://clerk.com/docs/reference/backend/types/backend-session){{ target: '_blank' }} IDs associated with the `Client`.
      */
     readonly sessionIds: string[],
     /**
-     * An array of [Session](https://clerk.com/docs/references/backend/types/backend-session){{ target: '_blank' }} objects associated with the `Client`.
+     * An array of [Session](https://clerk.com/docs/reference/backend/types/backend-session){{ target: '_blank' }} objects associated with the `Client`.
      */
     readonly sessions: Session[],
     /**
-     * The ID of the [`SignIn`](https://clerk.com/docs/references/javascript/sign-in){{ target: '_blank' }}.
+     * The ID of the [`SignIn`](https://clerk.com/docs/reference/javascript/sign-in){{ target: '_blank' }}.
      */
     readonly signInId: string | null,
     /**
-     * The ID of the [`SignUp`](https://clerk.com/docs/references/javascript/sign-up){{ target: '_blank' }}.
+     * The ID of the [`SignUp`](https://clerk.com/docs/reference/javascript/sign-up){{ target: '_blank' }}.
      */
     readonly signUpId: string | null,
     /**
-     * The ID of the last active [Session](https://clerk.com/docs/references/backend/types/backend-session).
+     * The ID of the last active [Session](https://clerk.com/docs/reference/backend/types/backend-session).
      */
     readonly lastActiveSessionId: string | null,
     /**

packages/backend/src/api/resources/CommercePlan.ts

@@ -4,7 +4,7 @@ import { Feature } from './Feature';
 import type { BillingPlanJSON } from './JSON';
 
 /**
- * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
+ * The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `BillingPlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
  *
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */

packages/backend/src/api/resources/CommerceSubscription.ts

@@ -4,7 +4,7 @@ import { BillingSubscriptionItem } from './CommerceSubscriptionItem';
 import type { BillingSubscriptionJSON } from './JSON';
 
 /**
- * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/references/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
+ * The `BillingSubscription` object is similar to the [`BillingSubscriptionResource`](/docs/reference/javascript/types/commerce-subscription-resource) object as it holds information about a subscription, as well as methods for managing it. However, the `BillingSubscription` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/billing/get/organizations/%7Borganization_id%7D/billing/subscription) and is not directly accessible from the Frontend API.
  *
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */

packages/backend/src/api/resources/CommerceSubscriptionItem.ts

@@ -4,7 +4,7 @@ import { BillingPlan } from './CommercePlan';
 import type { BillingSubscriptionItemJSON } from './JSON';
 
 /**
- * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/references/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
+ * The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItemResource`](/docs/reference/javascript/types/commerce-subscription-item-resource) object as it holds information about a subscription item, as well as methods for managing it. However, the `BillingSubscriptionItem` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/subscription_items) and is not directly accessible from the Frontend API.
  *
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */

packages/backend/src/api/resources/Deserializer.ts

@@ -57,7 +57,7 @@ type ResourceResponse<T> = {
  *
  * If the promise resolves, you will get back the [properties](#properties) listed below. `data` will be an array of the resource type you requested. You can use the `totalCount` property to determine how many total items exist remotely.
  *
- * Some methods that return this type allow pagination with the `limit` and `offset` parameters, in which case the first 10 items will be returned by default. For methods such as [`getAllowlistIdentifierList()`](https://clerk.com/docs/references/backend/allowlist/get-allowlist-identifier-list), which do not take a `limit` or `offset`, all items will be returned.
+ * Some methods that return this type allow pagination with the `limit` and `offset` parameters, in which case the first 10 items will be returned by default. For methods such as [`getAllowlistIdentifierList()`](https://clerk.com/docs/reference/backend/allowlist/get-allowlist-identifier-list), which do not take a `limit` or `offset`, all items will be returned.
  *
  * If the promise is rejected, you will receive a `ClerkAPIResponseError` or network error.
  *

packages/backend/src/api/resources/EmailAddress.ts

@@ -3,11 +3,11 @@ import type { EmailAddressJSON } from './JSON';
 import { Verification } from './Verification';
 
 /**
- * The Backend `EmailAddress` object is a model around an email address. Email addresses are one of the [identifiers](https://clerk.com/docs/authentication/configuration/sign-up-sign-in-options#identifiers) used to provide identification for users.
+ * The Backend `EmailAddress` object is a model around an email address.
  *
  * Email addresses must be **verified** to ensure that they are assigned to their rightful owners. The `EmailAddress` object holds all necessary state around the verification process.
  *
- * For implementation examples for adding and verifying email addresses, see the [email link custom flow](https://clerk.com/docs/custom-flows/email-links) and [email code custom flow](https://clerk.com/docs/custom-flows/add-email) guides.
+ * For implementation examples for adding and verifying email addresses, see the [email link custom flow](https://clerk.com/docs/guides/development/custom-flows/authentication/email-links) and [email code custom flow](https://clerk.com/docs/guides/development/custom-flows/account-updates/add-email) guides.
  */
 export class EmailAddress {
   constructor(