Skip to content

docs(repo): Fix clerk-docs links in Typedoc output - #8155

Merged
brkalow merged 1 commit into
mainfrom
ss/fix-clerk-docs-links
Mar 24, 2026
Merged

docs(repo): Fix clerk-docs links in Typedoc output#8155
brkalow merged 1 commit into
mainfrom
ss/fix-clerk-docs-links

Conversation

@SarahSoutoul

@SarahSoutoulSarahSoutoul commented Mar 23, 2026•
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Description

Fixes clerk-docs links for Typedoc output after PR merge here: #8079.

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 documentation link paths for error-related type references to reflect a streamlined documentation structure.

@SarahSoutoulSarahSoutoul self-assigned this Mar 23, 2026
@changeset-bot

changeset-botBot commented Mar 23, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 1fbf0a1

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

vercelBot commented Mar 23, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 23, 2026 10:14pm

Request Review

@pkg-pr-new

pkg-pr-newBot commented Mar 23, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1fbf0a1

@coderabbitai

coderabbitaiBot commented Mar 23, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Pro

Run ID: 55824b90-2f0d-4a10-b04c-9fd2eabf8178

📥 Commits

Reviewing files that changed from the base of the PR and between 4146b84 and 1fbf0a1.

📒 Files selected for processing (1)
  • .typedoc/custom-plugin.mjs
📝 Walkthrough

Walkthrough

Updated the TypeDoc custom plugin configuration to modify link rewriting rules for error-type references. The static link replacement entries for sign-in-errors and sign-up-errors now point to /docs/reference/types/errors instead of /docs/reference/javascript/types/errors. Additionally, the catch-all replacement rule that matches inline SignInErrors and SignUpErrors references was updated to generate links to the same new target path. The core replacement logic and control flow remain unchanged.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title 'docs(repo): Fix clerk-docs links in Typedoc output' directly describes the main change—fixing documentation links in TypeDoc output for clerk-docs references.

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

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.

@brkalow
brkalow merged commit 2fb8c5a into mainMar 24, 2026
44 checks passed
@brkalow
brkalow deleted the ss/fix-clerk-docs-links branch March 24, 2026 01:00
Ephem pushed a commit that referenced this pull request Mar 24, 2026
@SarahSoutoul@Ephem
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
d00ec57
wobsoriano pushed a commit that referenced this pull request Mar 26, 2026
@SarahSoutoul@wobsoriano
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
fd04fbd
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wobsorianowobsorianowobsoriano approved these changes
@brkalowbrkalowAwaiting requested review from brkalow

Assignees

@SarahSoutoulSarahSoutoul

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@wobsoriano@brkalow
, '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): Fix clerk-docs links in Typedoc output by SarahSoutoul · Pull Request #8155 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix clerk-docs links in Typedoc output - #8155
Merged
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Mar 24, 2026
Merged
docs(repo): Fix clerk-docs links in Typedoc output#8155
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Mar 23, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
Fixes clerk-docs links for Typedoc output after PR merge here: #8079.
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 documentation link paths for error-related type references to reflect a streamlined documentation structure.
@SarahSoutoulSarahSoutoul
self-assigned this
Mar 23, 2026
@changeset-bot
changeset-botBot
commented
Mar 23, 2026

Copy link


Copy Markdown

⚠️ No Changeset found
Latest commit: 1fbf0a1
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
vercelBot
commented
Mar 23, 2026

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 23, 2026 10:14pm
Request Review
@pkg-pr-new
pkg-pr-newBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/agent-toolkit
npm i https://pkg.pr.new/@clerk/agent-toolkit@8155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 1fbf0a1
@coderabbitai
coderabbitaiBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Contributor
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro
Run ID: 55824b90-2f0d-4a10-b04c-9fd2eabf8178
📥 Commits
Reviewing files that changed from the base of the PR and between 4146b84 and 1fbf0a1.
📒 Files selected for processing (1)
  • .typedoc/custom-plugin.mjs
📝 Walkthrough
Walkthrough
Updated the TypeDoc custom plugin configuration to modify link rewriting rules for error-type references. The static link replacement entries for sign-in-errors and sign-up-errors now point to /docs/reference/types/errors instead of /docs/reference/javascript/types/errors. Additionally, the catch-all replacement rule that matches inline SignInErrors and SignUpErrors references was updated to generate links to the same new target path. The core replacement logic and control flow remain unchanged.
🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title 'docs(repo): Fix clerk-docs links in Typedoc output' directly describes the main change—fixing documentation links in TypeDoc output for clerk-docs references.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
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.
@brkalow
brkalow
merged commit 2fb8c5a
into
mainMar 24, 2026

44 checks passed

@brkalow
brkalow
deleted the

ss/fix-clerk-docs-links

branch
March 24, 2026 01:00
Ephem pushed a commit
that referenced
this pull request
Mar 24, 2026
@SarahSoutoul@Ephem
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
d00ec57
wobsoriano pushed a commit
that referenced
this pull request
Mar 26, 2026
@SarahSoutoul@wobsoriano
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
fd04fbd
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wobsorianowobsorianowobsoriano approved these changes
@brkalowbrkalowAwaiting requested review from brkalow

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@wobsoriano@brkalow

, '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): Fix clerk-docs links in Typedoc output by SarahSoutoul · Pull Request #8155 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix clerk-docs links in Typedoc output - #8155
Merged
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Mar 24, 2026
Merged
docs(repo): Fix clerk-docs links in Typedoc output#8155
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Mar 23, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
Fixes clerk-docs links for Typedoc output after PR merge here: #8079.
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 documentation link paths for error-related type references to reflect a streamlined documentation structure.
@SarahSoutoulSarahSoutoul
self-assigned this
Mar 23, 2026
@changeset-bot
changeset-botBot
commented
Mar 23, 2026

Copy link


Copy Markdown

⚠️ No Changeset found
Latest commit: 1fbf0a1
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
vercelBot
commented
Mar 23, 2026

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 23, 2026 10:14pm
Request Review
@pkg-pr-new
pkg-pr-newBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/agent-toolkit
npm i https://pkg.pr.new/@clerk/agent-toolkit@8155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 1fbf0a1
@coderabbitai
coderabbitaiBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Contributor
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro
Run ID: 55824b90-2f0d-4a10-b04c-9fd2eabf8178
📥 Commits
Reviewing files that changed from the base of the PR and between 4146b84 and 1fbf0a1.
📒 Files selected for processing (1)
  • .typedoc/custom-plugin.mjs
📝 Walkthrough
Walkthrough
Updated the TypeDoc custom plugin configuration to modify link rewriting rules for error-type references. The static link replacement entries for sign-in-errors and sign-up-errors now point to /docs/reference/types/errors instead of /docs/reference/javascript/types/errors. Additionally, the catch-all replacement rule that matches inline SignInErrors and SignUpErrors references was updated to generate links to the same new target path. The core replacement logic and control flow remain unchanged.
🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title 'docs(repo): Fix clerk-docs links in Typedoc output' directly describes the main change—fixing documentation links in TypeDoc output for clerk-docs references.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
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.
@brkalow
brkalow
merged commit 2fb8c5a
into
mainMar 24, 2026

44 checks passed

@brkalow
brkalow
deleted the

ss/fix-clerk-docs-links

branch
March 24, 2026 01:00
Ephem pushed a commit
that referenced
this pull request
Mar 24, 2026
@SarahSoutoul@Ephem
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
d00ec57
wobsoriano pushed a commit
that referenced
this pull request
Mar 26, 2026
@SarahSoutoul@wobsoriano
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
fd04fbd
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wobsorianowobsorianowobsoriano approved these changes
@brkalowbrkalowAwaiting requested review from brkalow

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@wobsoriano@brkalow

, '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): Fix clerk-docs links in Typedoc output by SarahSoutoul · Pull Request #8155 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix clerk-docs links in Typedoc output - #8155
Merged
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Mar 24, 2026
Merged
docs(repo): Fix clerk-docs links in Typedoc output#8155
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Mar 23, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
Fixes clerk-docs links for Typedoc output after PR merge here: #8079.
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 documentation link paths for error-related type references to reflect a streamlined documentation structure.
@SarahSoutoulSarahSoutoul
self-assigned this
Mar 23, 2026
@changeset-bot
changeset-botBot
commented
Mar 23, 2026

Copy link


Copy Markdown

⚠️ No Changeset found
Latest commit: 1fbf0a1
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
vercelBot
commented
Mar 23, 2026

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 23, 2026 10:14pm
Request Review
@pkg-pr-new
pkg-pr-newBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/agent-toolkit
npm i https://pkg.pr.new/@clerk/agent-toolkit@8155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 1fbf0a1
@coderabbitai
coderabbitaiBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Contributor
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro
Run ID: 55824b90-2f0d-4a10-b04c-9fd2eabf8178
📥 Commits
Reviewing files that changed from the base of the PR and between 4146b84 and 1fbf0a1.
📒 Files selected for processing (1)
  • .typedoc/custom-plugin.mjs
📝 Walkthrough
Walkthrough
Updated the TypeDoc custom plugin configuration to modify link rewriting rules for error-type references. The static link replacement entries for sign-in-errors and sign-up-errors now point to /docs/reference/types/errors instead of /docs/reference/javascript/types/errors. Additionally, the catch-all replacement rule that matches inline SignInErrors and SignUpErrors references was updated to generate links to the same new target path. The core replacement logic and control flow remain unchanged.
🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title 'docs(repo): Fix clerk-docs links in Typedoc output' directly describes the main change—fixing documentation links in TypeDoc output for clerk-docs references.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
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.
@brkalow
brkalow
merged commit 2fb8c5a
into
mainMar 24, 2026

44 checks passed

@brkalow
brkalow
deleted the

ss/fix-clerk-docs-links

branch
March 24, 2026 01:00
Ephem pushed a commit
that referenced
this pull request
Mar 24, 2026
@SarahSoutoul@Ephem
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
d00ec57
wobsoriano pushed a commit
that referenced
this pull request
Mar 26, 2026
@SarahSoutoul@wobsoriano
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
fd04fbd
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wobsorianowobsorianowobsoriano approved these changes
@brkalowbrkalowAwaiting requested review from brkalow

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@wobsoriano@brkalow

, '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): Fix clerk-docs links in Typedoc output by SarahSoutoul · Pull Request #8155 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix clerk-docs links in Typedoc output - #8155
Merged
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Mar 24, 2026
Merged
docs(repo): Fix clerk-docs links in Typedoc output#8155
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Mar 23, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
Fixes clerk-docs links for Typedoc output after PR merge here: #8079.
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 documentation link paths for error-related type references to reflect a streamlined documentation structure.
@SarahSoutoulSarahSoutoul
self-assigned this
Mar 23, 2026
@changeset-bot
changeset-botBot
commented
Mar 23, 2026

Copy link


Copy Markdown

⚠️ No Changeset found
Latest commit: 1fbf0a1
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
vercelBot
commented
Mar 23, 2026

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 23, 2026 10:14pm
Request Review
@pkg-pr-new
pkg-pr-newBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/agent-toolkit
npm i https://pkg.pr.new/@clerk/agent-toolkit@8155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 1fbf0a1
@coderabbitai
coderabbitaiBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Contributor
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro
Run ID: 55824b90-2f0d-4a10-b04c-9fd2eabf8178
📥 Commits
Reviewing files that changed from the base of the PR and between 4146b84 and 1fbf0a1.
📒 Files selected for processing (1)
  • .typedoc/custom-plugin.mjs
📝 Walkthrough
Walkthrough
Updated the TypeDoc custom plugin configuration to modify link rewriting rules for error-type references. The static link replacement entries for sign-in-errors and sign-up-errors now point to /docs/reference/types/errors instead of /docs/reference/javascript/types/errors. Additionally, the catch-all replacement rule that matches inline SignInErrors and SignUpErrors references was updated to generate links to the same new target path. The core replacement logic and control flow remain unchanged.
🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title 'docs(repo): Fix clerk-docs links in Typedoc output' directly describes the main change—fixing documentation links in TypeDoc output for clerk-docs references.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
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.
@brkalow
brkalow
merged commit 2fb8c5a
into
mainMar 24, 2026

44 checks passed

@brkalow
brkalow
deleted the

ss/fix-clerk-docs-links

branch
March 24, 2026 01:00
Ephem pushed a commit
that referenced
this pull request
Mar 24, 2026
@SarahSoutoul@Ephem
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
d00ec57
wobsoriano pushed a commit
that referenced
this pull request
Mar 26, 2026
@SarahSoutoul@wobsoriano
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
fd04fbd
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wobsorianowobsorianowobsoriano approved these changes
@brkalowbrkalowAwaiting requested review from brkalow

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@wobsoriano@brkalow

, '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): Fix clerk-docs links in Typedoc output by SarahSoutoul · Pull Request #8155 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix clerk-docs links in Typedoc output - #8155
Merged
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Mar 24, 2026
Merged
docs(repo): Fix clerk-docs links in Typedoc output#8155
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Mar 23, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
Fixes clerk-docs links for Typedoc output after PR merge here: #8079.
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 documentation link paths for error-related type references to reflect a streamlined documentation structure.
@SarahSoutoulSarahSoutoul
self-assigned this
Mar 23, 2026
@changeset-bot
changeset-botBot
commented
Mar 23, 2026

Copy link


Copy Markdown

⚠️ No Changeset found
Latest commit: 1fbf0a1
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
vercelBot
commented
Mar 23, 2026

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 23, 2026 10:14pm
Request Review
@pkg-pr-new
pkg-pr-newBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/agent-toolkit
npm i https://pkg.pr.new/@clerk/agent-toolkit@8155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 1fbf0a1
@coderabbitai
coderabbitaiBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Contributor
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro
Run ID: 55824b90-2f0d-4a10-b04c-9fd2eabf8178
📥 Commits
Reviewing files that changed from the base of the PR and between 4146b84 and 1fbf0a1.
📒 Files selected for processing (1)
  • .typedoc/custom-plugin.mjs
📝 Walkthrough
Walkthrough
Updated the TypeDoc custom plugin configuration to modify link rewriting rules for error-type references. The static link replacement entries for sign-in-errors and sign-up-errors now point to /docs/reference/types/errors instead of /docs/reference/javascript/types/errors. Additionally, the catch-all replacement rule that matches inline SignInErrors and SignUpErrors references was updated to generate links to the same new target path. The core replacement logic and control flow remain unchanged.
🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title 'docs(repo): Fix clerk-docs links in Typedoc output' directly describes the main change—fixing documentation links in TypeDoc output for clerk-docs references.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
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.
@brkalow
brkalow
merged commit 2fb8c5a
into
mainMar 24, 2026

44 checks passed

@brkalow
brkalow
deleted the

ss/fix-clerk-docs-links

branch
March 24, 2026 01:00
Ephem pushed a commit
that referenced
this pull request
Mar 24, 2026
@SarahSoutoul@Ephem
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
d00ec57
wobsoriano pushed a commit
that referenced
this pull request
Mar 26, 2026
@SarahSoutoul@wobsoriano
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
fd04fbd
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wobsorianowobsorianowobsoriano approved these changes
@brkalowbrkalowAwaiting requested review from brkalow

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@wobsoriano@brkalow

, '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); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
docs(repo): Fix clerk-docs links in Typedoc output by SarahSoutoul · Pull Request #8155 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix clerk-docs links in Typedoc output - #8155
Merged
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Mar 24, 2026
Merged
docs(repo): Fix clerk-docs links in Typedoc output#8155
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Mar 23, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
Fixes clerk-docs links for Typedoc output after PR merge here: #8079.
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 documentation link paths for error-related type references to reflect a streamlined documentation structure.
@SarahSoutoulSarahSoutoul
self-assigned this
Mar 23, 2026
@changeset-bot
changeset-botBot
commented
Mar 23, 2026

Copy link


Copy Markdown

⚠️ No Changeset found
Latest commit: 1fbf0a1
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
vercelBot
commented
Mar 23, 2026

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 23, 2026 10:14pm
Request Review
@pkg-pr-new
pkg-pr-newBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/agent-toolkit
npm i https://pkg.pr.new/@clerk/agent-toolkit@8155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 1fbf0a1
@coderabbitai
coderabbitaiBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Contributor
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro
Run ID: 55824b90-2f0d-4a10-b04c-9fd2eabf8178
📥 Commits
Reviewing files that changed from the base of the PR and between 4146b84 and 1fbf0a1.
📒 Files selected for processing (1)
  • .typedoc/custom-plugin.mjs
📝 Walkthrough
Walkthrough
Updated the TypeDoc custom plugin configuration to modify link rewriting rules for error-type references. The static link replacement entries for sign-in-errors and sign-up-errors now point to /docs/reference/types/errors instead of /docs/reference/javascript/types/errors. Additionally, the catch-all replacement rule that matches inline SignInErrors and SignUpErrors references was updated to generate links to the same new target path. The core replacement logic and control flow remain unchanged.
🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title 'docs(repo): Fix clerk-docs links in Typedoc output' directly describes the main change—fixing documentation links in TypeDoc output for clerk-docs references.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
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.
@brkalow
brkalow
merged commit 2fb8c5a
into
mainMar 24, 2026

44 checks passed

@brkalow
brkalow
deleted the

ss/fix-clerk-docs-links

branch
March 24, 2026 01:00
Ephem pushed a commit
that referenced
this pull request
Mar 24, 2026
@SarahSoutoul@Ephem
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
d00ec57
wobsoriano pushed a commit
that referenced
this pull request
Mar 26, 2026
@SarahSoutoul@wobsoriano
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
fd04fbd
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wobsorianowobsorianowobsoriano approved these changes
@brkalowbrkalowAwaiting requested review from brkalow

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@wobsoriano@brkalow

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
docs(repo): Fix clerk-docs links in Typedoc output by SarahSoutoul · Pull Request #8155 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix clerk-docs links in Typedoc output - #8155
Merged
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Mar 24, 2026
Merged
docs(repo): Fix clerk-docs links in Typedoc output#8155
brkalow merged 1 commit into
mainfrom 
ss/fix-clerk-docs-links
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Mar 23, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
Fixes clerk-docs links for Typedoc output after PR merge here: #8079.
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 documentation link paths for error-related type references to reflect a streamlined documentation structure.
@SarahSoutoulSarahSoutoul
self-assigned this
Mar 23, 2026
@changeset-bot
changeset-botBot
commented
Mar 23, 2026

Copy link


Copy Markdown

⚠️ No Changeset found
Latest commit: 1fbf0a1
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
vercelBot
commented
Mar 23, 2026

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentMar 23, 2026 10:14pm
Request Review
@pkg-pr-new
pkg-pr-newBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Open in StackBlitz
@clerk/agent-toolkit
npm i https://pkg.pr.new/@clerk/agent-toolkit@8155

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 1fbf0a1
@coderabbitai
coderabbitaiBot
commented
Mar 23, 2026

Copy link


Copy Markdown

Contributor
No actionable comments were generated in the recent review. 🎉
ℹ️ Recent review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro
Run ID: 55824b90-2f0d-4a10-b04c-9fd2eabf8178
📥 Commits
Reviewing files that changed from the base of the PR and between 4146b84 and 1fbf0a1.
📒 Files selected for processing (1)
  • .typedoc/custom-plugin.mjs
📝 Walkthrough
Walkthrough
Updated the TypeDoc custom plugin configuration to modify link rewriting rules for error-type references. The static link replacement entries for sign-in-errors and sign-up-errors now point to /docs/reference/types/errors instead of /docs/reference/javascript/types/errors. Additionally, the catch-all replacement rule that matches inline SignInErrors and SignUpErrors references was updated to generate links to the same new target path. The core replacement logic and control flow remain unchanged.
🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check nameStatusExplanationResolution
Docstring Coverage⚠️ WarningDocstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title 'docs(repo): Fix clerk-docs links in Typedoc output' directly describes the main change—fixing documentation links in TypeDoc output for clerk-docs references.
✏️ Tip: You can configure your own custom pre-merge checks in the settings.
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.
@brkalow
brkalow
merged commit 2fb8c5a
into
mainMar 24, 2026

44 checks passed

@brkalow
brkalow
deleted the

ss/fix-clerk-docs-links

branch
March 24, 2026 01:00
Ephem pushed a commit
that referenced
this pull request
Mar 24, 2026
@SarahSoutoul@Ephem
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
d00ec57
wobsoriano pushed a commit
that referenced
this pull request
Mar 26, 2026
@SarahSoutoul@wobsoriano
docs(repo): Fix clerk-docs links in Typedoc output (#8155)
fd04fbd
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@wobsorianowobsorianowobsoriano approved these changes
@brkalowbrkalowAwaiting requested review from brkalow

Assignees

@SarahSoutoulSarahSoutoul

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@SarahSoutoul@wobsoriano@brkalow