fix(clerk-react): Change account portal links

[SarahSoutoul]

Description

Checklist

• pnpm test runs as expected.
• pnpm build runs as expected.
• (If applicable) JSDoc comments have been added or updated for any package exports
• (If applicable) Documentation has been updated

Type of change

• 🐛 Bug fix
• 🌟 New feature
• 🔨 Breaking change
• 📖 Refactoring / dependency upgrade / documentation
• other:

Summary by CodeRabbit

• Documentation
  • Updated Account Portal documentation references to point to the overview page.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[changeset-bot]

⚠️ No Changeset found

Latest commit: 8de6509

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
clerk-js-sandbox	Ready	Preview	Comment	Dec 5, 2025 10:12pm

[pkg-pr-new]

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@7384

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@7384

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@7384

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@7384

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@7384

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@7384

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@7384

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@7384

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@7384

@clerk/express

npm i https://pkg.pr.new/@clerk/express@7384

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@7384

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@7384

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@7384

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@7384

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@7384

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@7384

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@7384

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@7384

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@7384

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@7384

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@7384

@clerk/types

npm i https://pkg.pr.new/@clerk/types@7384

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@7384

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@7384

commit: 8de6509

[coderabbitai]

Walkthrough

Documentation comments in the ClerkOptions type were updated to reference the Account Portal overview page instead of a previous account-portal path, with no changes to type signatures or executable logic.

Changes

Cohort / File(s)	Summary
Documentation Updates packages/shared/src/types/clerk.ts	Updated documentation comments in ClerkOptions to reference the Account Portal overview page instead of the previous account-portal path

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A link here, a reference there,
Documentation gets some care,
The portal path now shines anew,
Readers guided, straight and true! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: updating account portal links in the clerk-react package, which aligns with the file summary showing documentation comments were updated to reference a different account portal page.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch brk.feat/customization-docs-tweaks

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 1bb6a46 and 8de6509.

📒 Files selected for processing (1)

• packages/shared/src/types/clerk.ts (3 hunks)

🧰 Additional context used

📓 Path-based instructions (7)

**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

All code must pass ESLint checks with the project's configuration

Files:

• packages/shared/src/types/clerk.ts

**/*.{js,jsx,ts,tsx,json,md,yml,yaml}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

Use Prettier for consistent code formatting

Files:

• packages/shared/src/types/clerk.ts

packages/**/src/**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

TypeScript is required for all packages

Files:

• packages/shared/src/types/clerk.ts

**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

Follow established naming conventions (PascalCase for components, camelCase for variables)

Prefer importing types from @clerk/shared/types instead of the deprecated @clerk/types alias

Files:

• packages/shared/src/types/clerk.ts

packages/**/src/**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

packages/**/src/**/*.{ts,tsx,js,jsx}: Maintain comprehensive JSDoc comments for public APIs
Use tree-shaking friendly exports
Validate all inputs and sanitize outputs
All public APIs must be documented with JSDoc
Use dynamic imports for optional features
Provide meaningful error messages to developers
Include error recovery suggestions where applicable
Log errors appropriately for debugging
Lazy load components and features when possible
Implement proper caching strategies
Use efficient data structures and algorithms
Implement proper logging with different levels

Files:

• packages/shared/src/types/clerk.ts

**/*.ts?(x)

📄 CodeRabbit inference engine (.cursor/rules/development.mdc)

Use proper TypeScript error types

Files:

• packages/shared/src/types/clerk.ts

**/*.{ts,tsx}

📄 CodeRabbit inference engine (.cursor/rules/typescript.mdc)

**/*.{ts,tsx}: Always define explicit return types for functions, especially public APIs
Use proper type annotations for variables and parameters where inference isn't clear
Avoid any type - prefer unknown when type is uncertain, then narrow with type guards
Implement type guards for unknown types using the pattern function isType(value: unknown): value is Type
Use interface for object shapes that might be extended
Use type for unions, primitives, and computed types
Prefer readonly properties for immutable data structures
Use private for internal implementation details in classes
Use protected for inheritance hierarchies
Use public explicitly for clarity in public APIs
Use mixins for shared behavior across unrelated classes in TypeScript
Use generic constraints with bounded type parameters like <T extends { id: string }>
Use utility types like Omit, Partial, and Pick for data transformation instead of manual type construction
Use discriminated unions instead of boolean flags for state management and API responses
Use mapped types for transforming object types
Use conditional types for type-level logic
Leverage template literal types for string manipulation at the type level
Use ES6 imports/exports consistently
Use default exports sparingly, prefer named exports
Document functions with JSDoc comments including @param, @returns, @throws, and @example tags
Create custom error classes that extend Error for specific error types
Use the Result pattern for error handling instead of throwing exceptions
Use optional chaining (?.) and nullish coalescing (??) operators for safe property access
Let TypeScript infer obvious types to reduce verbosity
Use const assertions with as const for literal types
Use satisfies operator for type checking without widening types
Declare readonly arrays and objects for immutable data structures
Use spread operator and array spread for immutable updates instead of mutations
Use lazy loading for large types...

Files:

• packages/shared/src/types/clerk.ts

🧬 Code graph analysis (1)

packages/shared/src/types/clerk.ts (1)

packages/shared/src/types/appearance.ts (1)

• Appearance (1058-1136)

🔇 Additional comments (1)

packages/shared/src/types/clerk.ts (1)

1074-1145: JSDoc documentation links for Account Portal consistently updated in ClerkOptions public API.

The four documentation links in appearance, localization, supportEmail, and waitlistUrl properties follow a consistent pattern using the standardized Account Portal URL (https://clerk.com/docs/guides/account-portal/overview). JSDoc comments remain comprehensive and properly formatted for the public API.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}