chore(types): Add examples for __experimental_startPath types

[alexcarpenter]

Description

Resolves USER-3694

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
  • Added usage examples for configuring an experimental start path in user and organization profile components, including sample values. Examples are visible in component props documentation and inline hints.
• Chores
  • Prepared a patch release.

[changeset-bot]

🦋 Changeset detected

Latest commit: ba12555

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 22 packages

Name	Type
@clerk/types	Patch
@clerk/agent-toolkit	Patch
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/clerk-js	Patch
@clerk/elements	Patch
@clerk/expo-passkeys	Patch
@clerk/clerk-expo	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/localizations	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/clerk-react	Patch
@clerk/remix	Patch
@clerk/shared	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch
@clerk/themes	Patch
@clerk/vue	Patch
@clerk/chrome-extension	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another 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	Oct 14, 2025 8:08pm

[coderabbitai]

Walkthrough

Adds a changeset bumping @clerk/types with a patch release and updates JSDoc in packages/types/src/clerk.ts to include example values for the __experimental_startPath property in UserProfileProps and OrganizationProfileProps. No functional or type signature changes.

Changes

Cohort / File(s)	Summary of Changes
Release / Changeset /.changeset/fresh-pandas-dress.md	Adds a changeset entry to patch-bump @clerk/types and notes example usage for \_\_experimental_startPath.
Types JSDoc Examples /packages/types/src/clerk.ts	Adds JSDoc example lines for \_\_experimental_startPath in UserProfileProps and OrganizationProfileProps. No functional or type declaration changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my whiskers, patch bump delight,
JSDoc crumbs placed just right.
Two paths to start, examples in tow,
No code to break, just clearer flow.
Thump-thump! I hop—release in sight 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Title Check	✅ Passed	The title accurately reflects the main change by stating that examples for the __experimental_startPath types are being added in the types package. It is concise, uses the appropriate chore scope, and helps readers understand the PR's intent at a glance.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ 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 alexcarpenter/start-path-examples

---

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

[pkg-pr-new]

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: ba12555