Skip to content

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

Merged
wobsoriano merged 5 commits into
mainfrom
ss/DOCS-11525
Jun 13, 2026
Merged

docs(repo): Update description of isSatellite prop for satellite domains guide#8845
wobsoriano merged 5 commits into
mainfrom
ss/DOCS-11525

Conversation

@SarahSoutoul

@SarahSoutoulSarahSoutoul commented Jun 12, 2026•
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

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.

@SarahSoutoulSarahSoutoul self-assigned this Jun 12, 2026
@changeset-bot

changeset-botBot commented Jun 12, 2026•
edited
Loading

Copy link
Copy Markdown

🦋 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
NameType
@clerk/sharedPatch
@clerk/astroPatch
@clerk/backendPatch
@clerk/chrome-extensionPatch
@clerk/clerk-jsPatch
@clerk/expo-passkeysPatch
@clerk/expoPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/localizationsPatch
@clerk/mswPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/reactPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
@clerk/uiPatch
@clerk/vuePatch
@clerk/swingsetPatch

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

vercelBot commented Jun 12, 2026•
edited
Loading

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 13, 2026 2:18am
swingsetReadyReadyPreview, CommentJun 13, 2026 2:18am

Request Review

@coderabbitai

coderabbitaiBot commented Jun 12, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

Review Change Stack

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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe 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✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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

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

@SarahSoutoulSarahSoutoul changed the title Revamp descriptipnUpdate description of isSatellite prop for satellite domains guideJun 12, 2026
@SarahSoutoulSarahSoutoul changed the title Update description of isSatellite prop for satellite domains guidedocs(repo): Update description of isSatellite prop for satellite domains guideJun 12, 2026
@pkg-pr-new

pkg-pr-newBot commented Jun 12, 2026•
edited
Loading

Copy link
Copy Markdown

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

@SarahSoutoulSarahSoutoul mentioned this pull request Jun 12, 2026
Merged
@github-actions

github-actionsBot commented Jun 12, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

API Changes Report

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

Summary

MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0

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.

@manovotnymanovotny mentioned this pull request Jun 12, 2026
Merged
5 tasks
manovotny
manovotny reviewed Jun 12, 2026
View reviewed changes
Comment threadpackages/shared/src/types/clerk.ts Outdated
@SarahSoutoul@manovotny
Update packages/shared/src/types/clerk.ts
0580610
Co-authored-by: Michael Novotny <manovotny@gmail.com>
@SarahSoutoul

SarahSoutoul commented Jun 12, 2026

Copy link
Copy Markdown
ContributorAuthor

@manovotny good with me merging?

@manovotny@claude
docs(shared): use absolute links and styleguide wording for isSatelli…
b5c258b
…te JSDoc, add changeset
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
manovotny
manovotny approved these changes Jun 13, 2026
View reviewed changes

@manovotnymanovotny left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@manovotny good with me merging?

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

@wobsoriano
wobsoriano merged commit d9b5c7d into mainJun 13, 2026
49 checks passed
@wobsoriano
wobsoriano deleted the ss/DOCS-11525 branch June 13, 2026 02:26
@clerk-cookieclerk-cookie mentioned this pull request Jun 13, 2026
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@manovotnymanovotnymanovotny approved these changes
@wobsorianowobsorianowobsoriano approved these changes
@alexisintechalexisintechAwaiting requested review from alexisintech

Assignees

@SarahSoutoulSarahSoutoul

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@manovotny@wobsoriano
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
docs(repo): Update description of isSatellite prop for satellite domains guide by SarahSoutoul · Pull Request #8845 · clerk/javascript · GitHub
Skip to content
docs(repo): Update description of isSatellite prop for satellite domains guide - #8845
Merged
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Jun 13, 2026
Merged
docs(repo): Update description of isSatellite prop for satellite domains guide#8845
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jun 12, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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.
@SarahSoutoulSarahSoutoul
self-assigned this
Jun 12, 2026
@changeset-bot
changeset-botBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/sharedPatch
@clerk/astroPatch
@clerk/backendPatch
@clerk/chrome-extensionPatch
@clerk/clerk-jsPatch
@clerk/expo-passkeysPatch
@clerk/expoPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/localizationsPatch
@clerk/mswPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/reactPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
@clerk/uiPatch
@clerk/vuePatch
@clerk/swingsetPatch
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
vercelBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 13, 2026 2:18am
swingsetReadyReadyPreview, CommentJun 13, 2026 2:18am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe 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✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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
Comment @coderabbitai help to get the list of available commands and usage tips.
@SarahSoutoulSarahSoutoul
changed the title
Revamp descriptipnUpdate description of isSatellite prop for satellite domains guideJun 12, 2026
@SarahSoutoulSarahSoutoul
changed the title
Update description of isSatellite prop for satellite domains guidedocs(repo): Update description of isSatellite prop for satellite domains guideJun 12, 2026
@pkg-pr-new
pkg-pr-newBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

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
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 12, 2026
 Merged

@github-actions
github-actionsBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-13T02:19:22.116Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
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.
@manovotnymanovotny
mentioned this pull request
Jun 12, 2026
 Merged

5 tasks
manovotny
manovotny
reviewed
Jun 12, 2026
View reviewed changes
Comment threadpackages/shared/src/types/clerk.ts
Outdated

@SarahSoutoul@manovotny
Update packages/shared/src/types/clerk.ts
0580610
Co-authored-by: Michael Novotny <manovotny@gmail.com>
@SarahSoutoul
SarahSoutoul
commented
Jun 12, 2026

Copy link


Copy Markdown

ContributorAuthor
@manovotny good with me merging?
@manovotny@claude
docs(shared): use absolute links and styleguide wording for isSatelli…
b5c258b
…te JSDoc, add changeset
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
manovotny
manovotny
approved these changes
Jun 13, 2026
View reviewed changes
@manovotnymanovotny
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@manovotny good with me merging?
With a slight tweak in b5c258b, yes, I'm good. 👍
@wobsoriano
wobsoriano
merged commit d9b5c7d
into
mainJun 13, 2026

49 checks passed

@wobsoriano
wobsoriano
deleted the

ss/DOCS-11525

branch
June 13, 2026 02:26
@clerk-cookieclerk-cookie
mentioned this pull request
Jun 13, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@manovotnymanovotnymanovotny approved these changes
@wobsorianowobsorianowobsoriano approved these changes
@alexisintechalexisintechAwaiting requested review from alexisintech

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@manovotny@wobsoriano

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
docs(repo): Update description of isSatellite prop for satellite domains guide by SarahSoutoul · Pull Request #8845 · clerk/javascript · GitHub
Skip to content
docs(repo): Update description of isSatellite prop for satellite domains guide - #8845
Merged
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Jun 13, 2026
Merged
docs(repo): Update description of isSatellite prop for satellite domains guide#8845
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jun 12, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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.
@SarahSoutoulSarahSoutoul
self-assigned this
Jun 12, 2026
@changeset-bot
changeset-botBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/sharedPatch
@clerk/astroPatch
@clerk/backendPatch
@clerk/chrome-extensionPatch
@clerk/clerk-jsPatch
@clerk/expo-passkeysPatch
@clerk/expoPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/localizationsPatch
@clerk/mswPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/reactPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
@clerk/uiPatch
@clerk/vuePatch
@clerk/swingsetPatch
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
vercelBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 13, 2026 2:18am
swingsetReadyReadyPreview, CommentJun 13, 2026 2:18am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe 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✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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
Comment @coderabbitai help to get the list of available commands and usage tips.
@SarahSoutoulSarahSoutoul
changed the title
Revamp descriptipnUpdate description of isSatellite prop for satellite domains guideJun 12, 2026
@SarahSoutoulSarahSoutoul
changed the title
Update description of isSatellite prop for satellite domains guidedocs(repo): Update description of isSatellite prop for satellite domains guideJun 12, 2026
@pkg-pr-new
pkg-pr-newBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

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
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 12, 2026
 Merged

@github-actions
github-actionsBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-13T02:19:22.116Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
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.
@manovotnymanovotny
mentioned this pull request
Jun 12, 2026
 Merged

5 tasks
manovotny
manovotny
reviewed
Jun 12, 2026
View reviewed changes
Comment threadpackages/shared/src/types/clerk.ts
Outdated

@SarahSoutoul@manovotny
Update packages/shared/src/types/clerk.ts
0580610
Co-authored-by: Michael Novotny <manovotny@gmail.com>
@SarahSoutoul
SarahSoutoul
commented
Jun 12, 2026

Copy link


Copy Markdown

ContributorAuthor
@manovotny good with me merging?
@manovotny@claude
docs(shared): use absolute links and styleguide wording for isSatelli…
b5c258b
…te JSDoc, add changeset
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
manovotny
manovotny
approved these changes
Jun 13, 2026
View reviewed changes
@manovotnymanovotny
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@manovotny good with me merging?
With a slight tweak in b5c258b, yes, I'm good. 👍
@wobsoriano
wobsoriano
merged commit d9b5c7d
into
mainJun 13, 2026

49 checks passed

@wobsoriano
wobsoriano
deleted the

ss/DOCS-11525

branch
June 13, 2026 02:26
@clerk-cookieclerk-cookie
mentioned this pull request
Jun 13, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@manovotnymanovotnymanovotny approved these changes
@wobsorianowobsorianowobsoriano approved these changes
@alexisintechalexisintechAwaiting requested review from alexisintech

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@manovotny@wobsoriano

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
docs(repo): Update description of isSatellite prop for satellite domains guide by SarahSoutoul · Pull Request #8845 · clerk/javascript · GitHub
Skip to content
docs(repo): Update description of isSatellite prop for satellite domains guide - #8845
Merged
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Jun 13, 2026
Merged
docs(repo): Update description of isSatellite prop for satellite domains guide#8845
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jun 12, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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.
@SarahSoutoulSarahSoutoul
self-assigned this
Jun 12, 2026
@changeset-bot
changeset-botBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/sharedPatch
@clerk/astroPatch
@clerk/backendPatch
@clerk/chrome-extensionPatch
@clerk/clerk-jsPatch
@clerk/expo-passkeysPatch
@clerk/expoPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/localizationsPatch
@clerk/mswPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/reactPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
@clerk/uiPatch
@clerk/vuePatch
@clerk/swingsetPatch
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
vercelBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 13, 2026 2:18am
swingsetReadyReadyPreview, CommentJun 13, 2026 2:18am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe 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✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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
Comment @coderabbitai help to get the list of available commands and usage tips.
@SarahSoutoulSarahSoutoul
changed the title
Revamp descriptipnUpdate description of isSatellite prop for satellite domains guideJun 12, 2026
@SarahSoutoulSarahSoutoul
changed the title
Update description of isSatellite prop for satellite domains guidedocs(repo): Update description of isSatellite prop for satellite domains guideJun 12, 2026
@pkg-pr-new
pkg-pr-newBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

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
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 12, 2026
 Merged

@github-actions
github-actionsBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-13T02:19:22.116Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
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.
@manovotnymanovotny
mentioned this pull request
Jun 12, 2026
 Merged

5 tasks
manovotny
manovotny
reviewed
Jun 12, 2026
View reviewed changes
Comment threadpackages/shared/src/types/clerk.ts
Outdated

@SarahSoutoul@manovotny
Update packages/shared/src/types/clerk.ts
0580610
Co-authored-by: Michael Novotny <manovotny@gmail.com>
@SarahSoutoul
SarahSoutoul
commented
Jun 12, 2026

Copy link


Copy Markdown

ContributorAuthor
@manovotny good with me merging?
@manovotny@claude
docs(shared): use absolute links and styleguide wording for isSatelli…
b5c258b
…te JSDoc, add changeset
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
manovotny
manovotny
approved these changes
Jun 13, 2026
View reviewed changes
@manovotnymanovotny
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@manovotny good with me merging?
With a slight tweak in b5c258b, yes, I'm good. 👍
@wobsoriano
wobsoriano
merged commit d9b5c7d
into
mainJun 13, 2026

49 checks passed

@wobsoriano
wobsoriano
deleted the

ss/DOCS-11525

branch
June 13, 2026 02:26
@clerk-cookieclerk-cookie
mentioned this pull request
Jun 13, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@manovotnymanovotnymanovotny approved these changes
@wobsorianowobsorianowobsoriano approved these changes
@alexisintechalexisintechAwaiting requested review from alexisintech

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@manovotny@wobsoriano

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
docs(repo): Update description of isSatellite prop for satellite domains guide by SarahSoutoul · Pull Request #8845 · clerk/javascript · GitHub
Skip to content
docs(repo): Update description of isSatellite prop for satellite domains guide - #8845
Merged
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Jun 13, 2026
Merged
docs(repo): Update description of isSatellite prop for satellite domains guide#8845
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jun 12, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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.
@SarahSoutoulSarahSoutoul
self-assigned this
Jun 12, 2026
@changeset-bot
changeset-botBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/sharedPatch
@clerk/astroPatch
@clerk/backendPatch
@clerk/chrome-extensionPatch
@clerk/clerk-jsPatch
@clerk/expo-passkeysPatch
@clerk/expoPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/localizationsPatch
@clerk/mswPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/reactPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
@clerk/uiPatch
@clerk/vuePatch
@clerk/swingsetPatch
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
vercelBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 13, 2026 2:18am
swingsetReadyReadyPreview, CommentJun 13, 2026 2:18am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe 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✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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
Comment @coderabbitai help to get the list of available commands and usage tips.
@SarahSoutoulSarahSoutoul
changed the title
Revamp descriptipnUpdate description of isSatellite prop for satellite domains guideJun 12, 2026
@SarahSoutoulSarahSoutoul
changed the title
Update description of isSatellite prop for satellite domains guidedocs(repo): Update description of isSatellite prop for satellite domains guideJun 12, 2026
@pkg-pr-new
pkg-pr-newBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

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
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 12, 2026
 Merged

@github-actions
github-actionsBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-13T02:19:22.116Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
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.
@manovotnymanovotny
mentioned this pull request
Jun 12, 2026
 Merged

5 tasks
manovotny
manovotny
reviewed
Jun 12, 2026
View reviewed changes
Comment threadpackages/shared/src/types/clerk.ts
Outdated

@SarahSoutoul@manovotny
Update packages/shared/src/types/clerk.ts
0580610
Co-authored-by: Michael Novotny <manovotny@gmail.com>
@SarahSoutoul
SarahSoutoul
commented
Jun 12, 2026

Copy link


Copy Markdown

ContributorAuthor
@manovotny good with me merging?
@manovotny@claude
docs(shared): use absolute links and styleguide wording for isSatelli…
b5c258b
…te JSDoc, add changeset
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
manovotny
manovotny
approved these changes
Jun 13, 2026
View reviewed changes
@manovotnymanovotny
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@manovotny good with me merging?
With a slight tweak in b5c258b, yes, I'm good. 👍
@wobsoriano
wobsoriano
merged commit d9b5c7d
into
mainJun 13, 2026

49 checks passed

@wobsoriano
wobsoriano
deleted the

ss/DOCS-11525

branch
June 13, 2026 02:26
@clerk-cookieclerk-cookie
mentioned this pull request
Jun 13, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@manovotnymanovotnymanovotny approved these changes
@wobsorianowobsorianowobsoriano approved these changes
@alexisintechalexisintechAwaiting requested review from alexisintech

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@manovotny@wobsoriano

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
docs(repo): Update description of isSatellite prop for satellite domains guide by SarahSoutoul · Pull Request #8845 · clerk/javascript · GitHub
Skip to content
docs(repo): Update description of isSatellite prop for satellite domains guide - #8845
Merged
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Jun 13, 2026
Merged
docs(repo): Update description of isSatellite prop for satellite domains guide#8845
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jun 12, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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.
@SarahSoutoulSarahSoutoul
self-assigned this
Jun 12, 2026
@changeset-bot
changeset-botBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/sharedPatch
@clerk/astroPatch
@clerk/backendPatch
@clerk/chrome-extensionPatch
@clerk/clerk-jsPatch
@clerk/expo-passkeysPatch
@clerk/expoPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/localizationsPatch
@clerk/mswPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/reactPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
@clerk/uiPatch
@clerk/vuePatch
@clerk/swingsetPatch
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
vercelBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 13, 2026 2:18am
swingsetReadyReadyPreview, CommentJun 13, 2026 2:18am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe 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✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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
Comment @coderabbitai help to get the list of available commands and usage tips.
@SarahSoutoulSarahSoutoul
changed the title
Revamp descriptipnUpdate description of isSatellite prop for satellite domains guideJun 12, 2026
@SarahSoutoulSarahSoutoul
changed the title
Update description of isSatellite prop for satellite domains guidedocs(repo): Update description of isSatellite prop for satellite domains guideJun 12, 2026
@pkg-pr-new
pkg-pr-newBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

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
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 12, 2026
 Merged

@github-actions
github-actionsBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-13T02:19:22.116Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
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.
@manovotnymanovotny
mentioned this pull request
Jun 12, 2026
 Merged

5 tasks
manovotny
manovotny
reviewed
Jun 12, 2026
View reviewed changes
Comment threadpackages/shared/src/types/clerk.ts
Outdated

@SarahSoutoul@manovotny
Update packages/shared/src/types/clerk.ts
0580610
Co-authored-by: Michael Novotny <manovotny@gmail.com>
@SarahSoutoul
SarahSoutoul
commented
Jun 12, 2026

Copy link


Copy Markdown

ContributorAuthor
@manovotny good with me merging?
@manovotny@claude
docs(shared): use absolute links and styleguide wording for isSatelli…
b5c258b
…te JSDoc, add changeset
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
manovotny
manovotny
approved these changes
Jun 13, 2026
View reviewed changes
@manovotnymanovotny
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@manovotny good with me merging?
With a slight tweak in b5c258b, yes, I'm good. 👍
@wobsoriano
wobsoriano
merged commit d9b5c7d
into
mainJun 13, 2026

49 checks passed

@wobsoriano
wobsoriano
deleted the

ss/DOCS-11525

branch
June 13, 2026 02:26
@clerk-cookieclerk-cookie
mentioned this pull request
Jun 13, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@manovotnymanovotnymanovotny approved these changes
@wobsorianowobsorianowobsoriano approved these changes
@alexisintechalexisintechAwaiting requested review from alexisintech

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@manovotny@wobsoriano

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
docs(repo): Update description of isSatellite prop for satellite domains guide by SarahSoutoul · Pull Request #8845 · clerk/javascript · GitHub
Skip to content
docs(repo): Update description of isSatellite prop for satellite domains guide - #8845
Merged
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Jun 13, 2026
Merged
docs(repo): Update description of isSatellite prop for satellite domains guide#8845
wobsoriano merged 5 commits into
mainfrom 
ss/DOCS-11525
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jun 12, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
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.
@SarahSoutoulSarahSoutoul
self-assigned this
Jun 12, 2026
@changeset-bot
changeset-botBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 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
NameType
@clerk/sharedPatch
@clerk/astroPatch
@clerk/backendPatch
@clerk/chrome-extensionPatch
@clerk/clerk-jsPatch
@clerk/expo-passkeysPatch
@clerk/expoPatch
@clerk/expressPatch
@clerk/fastifyPatch
@clerk/honoPatch
@clerk/localizationsPatch
@clerk/mswPatch
@clerk/nextjsPatch
@clerk/nuxtPatch
@clerk/react-routerPatch
@clerk/reactPatch
@clerk/tanstack-react-startPatch
@clerk/testingPatch
@clerk/uiPatch
@clerk/vuePatch
@clerk/swingsetPatch
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
vercelBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJun 13, 2026 2:18am
swingsetReadyReadyPreview, CommentJun 13, 2026 2:18am
Request Review
@coderabbitai
coderabbitaiBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
Review Change Stack
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 nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe 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✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck 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
Comment @coderabbitai help to get the list of available commands and usage tips.
@SarahSoutoulSarahSoutoul
changed the title
Revamp descriptipnUpdate description of isSatellite prop for satellite domains guideJun 12, 2026
@SarahSoutoulSarahSoutoul
changed the title
Update description of isSatellite prop for satellite domains guidedocs(repo): Update description of isSatellite prop for satellite domains guideJun 12, 2026
@pkg-pr-new
pkg-pr-newBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

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
@SarahSoutoulSarahSoutoul
mentioned this pull request
Jun 12, 2026
 Merged

@github-actions
github-actionsBot
commented
Jun 12, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-06-13T02:19:22.116Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
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.
@manovotnymanovotny
mentioned this pull request
Jun 12, 2026
 Merged

5 tasks
manovotny
manovotny
reviewed
Jun 12, 2026
View reviewed changes
Comment threadpackages/shared/src/types/clerk.ts
Outdated

@SarahSoutoul@manovotny
Update packages/shared/src/types/clerk.ts
0580610
Co-authored-by: Michael Novotny <manovotny@gmail.com>
@SarahSoutoul
SarahSoutoul
commented
Jun 12, 2026

Copy link


Copy Markdown

ContributorAuthor
@manovotny good with me merging?
@manovotny@claude
docs(shared): use absolute links and styleguide wording for isSatelli…
b5c258b
…te JSDoc, add changeset
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
manovotny
manovotny
approved these changes
Jun 13, 2026
View reviewed changes
@manovotnymanovotny
left a comment


Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@manovotny good with me merging?
With a slight tweak in b5c258b, yes, I'm good. 👍
@wobsoriano
wobsoriano
merged commit d9b5c7d
into
mainJun 13, 2026

49 checks passed

@wobsoriano
wobsoriano
deleted the

ss/DOCS-11525

branch
June 13, 2026 02:26
@clerk-cookieclerk-cookie
mentioned this pull request
Jun 13, 2026
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@manovotnymanovotnymanovotny approved these changes
@wobsorianowobsorianowobsoriano approved these changes
@alexisintechalexisintechAwaiting requested review from alexisintech

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@manovotny@wobsoriano