docs(repo): Update description of isSatellite prop for satellite domains guide

[SarahSoutoul]

Description

This PR updates the description of isSatellite prop as part of the work of this PR and this ticket.

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
  • Clarified that satellite behavior must be configured at load/runtime, distinct from domain configuration set during initialization.
• Chores
  • Added a release metadata entry to record this documentation clarification.

[changeset-bot]

🦋 Changeset detected

Latest commit: b5c258b

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

This PR includes changesets to release 21 packages

Name	Type
@clerk/shared	Patch
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/chrome-extension	Patch
@clerk/clerk-js	Patch
@clerk/expo-passkeys	Patch
@clerk/expo	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/hono	Patch
@clerk/localizations	Patch
@clerk/msw	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/react	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch
@clerk/ui	Patch
@clerk/vue	Patch
@clerk/swingset	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	Actions	Updated (UTC)
clerk-js-sandbox	Ready	Preview, Comment	Jun 13, 2026 2:18am
swingset	Ready	Preview, Comment	Jun 13, 2026 2:18am

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 830124b1-5b88-42d7-8db5-5e6d5388d951

📥 Commits

Reviewing files that changed from the base of the PR and between 0580610 and b5c258b.

📒 Files selected for processing (2)

• .changeset/silver-poems-repeat.md
• packages/shared/src/types/clerk.ts

✅ Files skipped from review due to trivial changes (2)

• packages/shared/src/types/clerk.ts
• .changeset/silver-poems-repeat.md

---

📝 Walkthrough

Walkthrough

This PR updates the JSDoc for ClerkOptions.isSatellite to state the option must be provided to load(), distinguishing it from the domain option which is configured in the Clerk constructor.

Changes

Type Documentation Update

Layer / File(s)	Summary
ClerkOptions.isSatellite documentation clarification packages/shared/src/types/clerk.ts, .changeset/silver-poems-repeat.md	JSDoc for isSatellite updated to clarify it must be passed to load(), unlike domain which is set in the constructor. A two-line changeset file was added.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 I hopped through lines both small and neat,
A doc now tells where satellites meet,
Pass isSatellite when you call load,
Not where the Clerk constructor rode,
A rabbit's note to keep docs sweet.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the main change: updating the isSatellite prop description/documentation, which aligns with the JSDoc update shown in the raw summary.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

---

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.}

[pkg-pr-new]

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@8845

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@8845

@clerk/upgrade

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

@clerk/vue

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

commit: b5c258b

[github-actions]

API Changes Report

Generated by Break Check on 2026-06-13T02:19:22.116Z

Summary

Metric	Count
Packages analyzed	19
Packages with changes	0
🔴 Breaking changes	0
🟡 Non-breaking changes	0
🟢 Additions	0

Note
Break Check could not snapshot 1 subpath; the diff below excludes them.

• @clerk/astro ./env: ambient declaration file (no top-level import or export): API Extractor can only analyze module entry points, so this global-augmentation surface cannot be snapshotted; add "@clerk/astro#./env" to ignoreSubpaths to acknowledge it (API Extractor: Unable to determine module for: /home/runner/_work/javascript/javascript/packages/astro/env.d.ts)

No API Changes Detected

All packages have stable APIs with no detected changes.

---

Report generated by Break Check

_{Last ran on b5c258b.}

[SarahSoutoul]

@manovotny good with me merging?

[manovotny]

@manovotny good with me merging?

With a slight tweak in b5c258b, yes, I'm good. 👍