Skip to content

docs(repo): Fix Typedoc outputs - #9101

Merged
wobsoriano merged 2 commits into
mainfrom
ss/fix-typedoc-outputs
Jul 9, 2026
Merged

docs(repo): Fix Typedoc outputs#9101
wobsoriano merged 2 commits into
mainfrom
ss/fix-typedoc-outputs

Conversation

@SarahSoutoul

@SarahSoutoulSarahSoutoul commented Jul 7, 2026•
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Description

This brings in fixes for broken output noticed here: https://github.com/clerk/clerk/pull/2881.

  • Add a TypeDoc LINK_REPLACEMENTS entry for protect-check-resource so generated ProtectCheckResource links resolve to /docs/reference/types/protect-check-resource
  • Add missing JSDoc descriptions for ProtectCheckResource.token, sdkUrl, and uiHints so the generated reference page includes those properties
  • Add an empty changeset for this docs/tooling-only update

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

Summary by CodeRabbit

  • Documentation
    • Updated reference link rewriting so links for the public resource now point to the correct docs page.
    • Expanded inline field documentation for ProtectCheckResource, including clearer descriptions for token and sdkUrl.
  • Chores
    • Added a changeset to track the documentation update.

@SarahSoutoulSarahSoutoul self-assigned this Jul 7, 2026
@vercel

vercelBot commented Jul 7, 2026•
edited
Loading

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 7, 2026 4:50pm
swingsetReadyReadyPreview, CommentJul 7, 2026 4:50pm

Request Review

@changeset-bot

changeset-botBot commented Jul 7, 2026•
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 2d68d07

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

This PR includes changesets to release 0 packages

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

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

@coderabbitai

coderabbitaiBot commented Jul 7, 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 Plus

Run ID: 0def8084-6566-4a89-9e00-c285510beee9

📥 Commits

Reviewing files that changed from the base of the PR and between 521e752 and 2d68d07.

📒 Files selected for processing (1)
  • packages/shared/src/types/signUpCommon.ts
✅ Files skipped from review due to trivial changes (1)
  • packages/shared/src/types/signUpCommon.ts
📝 Walkthrough

Walkthrough

Adds JSDoc documentation to ProtectCheckResource properties, registers a TypeDoc link replacement for protect-check-resource, and adds a changeset file.

Changes

ProtectCheckResource Documentation and Link Mapping

Layer / File(s)Summary
JSDoc comments and link replacement
packages/shared/src/types/signUpCommon.ts, .typedoc/custom-plugin.mjs, .changeset/protect-check-typedoc-link.md		Adds explicit JSDoc blocks for token, sdkUrl, expiresAt, and uiHints in ProtectCheckResource, adds a LINK_REPLACEMENTS entry for protect-check-resource, and includes a new changeset file.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

Poem

A bunny hops through docs so bright,
With links that point just right, just right.
token, sdkUrl got their say,
And protect-check-resource found its way.
A tidy changeset, snug and neat—
Nose twitch, thump thump, docs complete.

🚥 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 clearly matches the docs-focused TypeDoc link and output fixes in this changeset.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

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

@github-actions

github-actionsBot commented Jul 7, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-07-07T16:52:01.899Z

Summary

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

No API Changes Detected

All packages have stable APIs with no detected changes.

Report generated by Break Check

Last ran on 2d68d07.

coderabbitai[bot]
coderabbitaiBot reviewed Jul 7, 2026
View reviewed changes

@coderabbitaicoderabbitaiBot 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.

🧹 Nitpick comments (1)
packages/shared/src/types/signUpCommon.ts (1)

42-56: 🧹 Nitpick | 🔵 Trivial

Loop in Docs on this customer-facing JSDoc.

ProtectCheckResource is part of the TypeDoc entrypoint, so these comments will surface in generated reference docs. Please have the Docs team verify the wording and route alignment before merge.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/shared/src/types/signUpCommon.ts` around lines 42 - 56, The
customer-facing JSDoc on ProtectCheckResource in signUpCommon.ts will be
published in TypeDoc, so the wording and route alignment need Docs review before
merge. Please coordinate with the Docs team to verify and approve the comments
for token, sdkUrl, expiresAt, and the surrounding challenge hints section, and
update the text only if they request clarifications. Keep the public-facing
descriptions consistent with the generated reference docs entrypoint.

Source: Path instructions

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/shared/src/types/signUpCommon.ts`:
- Around line 42-56: The customer-facing JSDoc on ProtectCheckResource in
signUpCommon.ts will be published in TypeDoc, so the wording and route alignment
need Docs review before merge. Please coordinate with the Docs team to verify
and approve the comments for token, sdkUrl, expiresAt, and the surrounding
challenge hints section, and update the text only if they request
clarifications. Keep the public-facing descriptions consistent with the
generated reference docs entrypoint.
ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 01c85e02-c4e9-4de0-bad2-a261ab9567bc

📥 Commits

Reviewing files that changed from the base of the PR and between 6f97ef5 and 521e752.

📒 Files selected for processing (3)
  • .changeset/protect-check-typedoc-link.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/signUpCommon.ts

@pkg-pr-new

pkg-pr-newBot commented Jul 7, 2026•
edited
Loading

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@9101

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@9101

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@9101

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 2d68d07

manovotny
manovotny reviewed Jul 7, 2026
View reviewed changes
Comment thread.typedoc/custom-plugin.mjs
@wobsoriano
wobsoriano merged commit a053917 into mainJul 9, 2026
53 checks passed
@wobsoriano
wobsoriano deleted the ss/fix-typedoc-outputs branch July 9, 2026 04:25
@coderabbitaicoderabbitaiBot mentioned this pull request Jul 9, 2026
Merged
9 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments
@manovotnymanovotnymanovotny 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): Fix Typedoc outputs by SarahSoutoul · Pull Request #9101 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix Typedoc outputs - #9101
Merged
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Jul 9, 2026
Merged
docs(repo): Fix Typedoc outputs#9101
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jul 7, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This brings in fixes for broken output noticed here: https://github.com/clerk/clerk/pull/2881.
  • Add a TypeDoc LINK_REPLACEMENTS entry for protect-check-resource so generated ProtectCheckResource links resolve to /docs/reference/types/protect-check-resource
  • Add missing JSDoc descriptions for ProtectCheckResource.token, sdkUrl, and uiHints so the generated reference page includes those properties
  • Add an empty changeset for this docs/tooling-only update
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
Summary by CodeRabbit
  • Documentation
    • Updated reference link rewriting so links for the public resource now point to the correct docs page.
    • Expanded inline field documentation for ProtectCheckResource, including clearer descriptions for token and sdkUrl.
  • Chores
    • Added a changeset to track the documentation update.
@SarahSoutoulSarahSoutoul
self-assigned this
Jul 7, 2026
@vercel
vercelBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 7, 2026 4:50pm
swingsetReadyReadyPreview, CommentJul 7, 2026 4:50pm
Request Review
@changeset-bot
changeset-botBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 2d68d07
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
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
@coderabbitai
coderabbitaiBot
commented
Jul 7, 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 Plus
Run ID: 0def8084-6566-4a89-9e00-c285510beee9
📥 Commits
Reviewing files that changed from the base of the PR and between 521e752 and 2d68d07.
📒 Files selected for processing (1)
  • packages/shared/src/types/signUpCommon.ts
✅ Files skipped from review due to trivial changes (1)
  • packages/shared/src/types/signUpCommon.ts
📝 Walkthrough
Walkthrough
Adds JSDoc documentation to ProtectCheckResource properties, registers a TypeDoc link replacement for protect-check-resource, and adds a changeset file.
Changes
ProtectCheckResource Documentation and Link Mapping
Layer / File(s)Summary
JSDoc comments and link replacement
packages/shared/src/types/signUpCommon.ts, .typedoc/custom-plugin.mjs, .changeset/protect-check-typedoc-link.md		Adds explicit JSDoc blocks for token, sdkUrl, expiresAt, and uiHints in ProtectCheckResource, adds a LINK_REPLACEMENTS entry for protect-check-resource, and includes a new changeset file.
Estimated code review effort: 1 (Trivial) | ~3 minutes
Possibly related PRs
Poem
A bunny hops through docs so bright,

With links that point just right, just right.
token, sdkUrl got their say,

And protect-check-resource found its way.

A tidy changeset, snug and neat—

Nose twitch, thump thump, docs complete.
🚥 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 clearly matches the docs-focused TypeDoc link and output fixes in this changeset.
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.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@github-actions
github-actionsBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-07-07T16:52:01.899Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 2d68d07.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jul 7, 2026
View reviewed changes
@coderabbitaicoderabbitaiBot
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.

🧹 Nitpick comments (1)
packages/shared/src/types/signUpCommon.ts (1)
42-56: 🧹 Nitpick | 🔵 Trivial
Loop in Docs on this customer-facing JSDoc.
ProtectCheckResource is part of the TypeDoc entrypoint, so these comments will surface in generated reference docs. Please have the Docs team verify the wording and route alignment before merge.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/shared/src/types/signUpCommon.ts` around lines 42 - 56, The
customer-facing JSDoc on ProtectCheckResource in signUpCommon.ts will be
published in TypeDoc, so the wording and route alignment need Docs review before
merge. Please coordinate with the Docs team to verify and approve the comments
for token, sdkUrl, expiresAt, and the surrounding challenge hints section, and
update the text only if they request clarifications. Keep the public-facing
descriptions consistent with the generated reference docs entrypoint.

Source: Path instructions
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/shared/src/types/signUpCommon.ts`:
- Around line 42-56: The customer-facing JSDoc on ProtectCheckResource in
signUpCommon.ts will be published in TypeDoc, so the wording and route alignment
need Docs review before merge. Please coordinate with the Docs team to verify
and approve the comments for token, sdkUrl, expiresAt, and the surrounding
challenge hints section, and update the text only if they request
clarifications. Keep the public-facing descriptions consistent with the
generated reference docs entrypoint.

ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 01c85e02-c4e9-4de0-bad2-a261ab9567bc
📥 Commits
Reviewing files that changed from the base of the PR and between 6f97ef5 and 521e752.
📒 Files selected for processing (3)
  • .changeset/protect-check-typedoc-link.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/signUpCommon.ts
@pkg-pr-new
pkg-pr-newBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9101

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9101

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9101

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9101

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 2d68d07
manovotny
manovotny
reviewed
Jul 7, 2026
View reviewed changes
Comment thread.typedoc/custom-plugin.mjs
@wobsoriano
wobsoriano
merged commit a053917
into
mainJul 9, 2026

53 checks passed

@wobsoriano
wobsoriano
deleted the

ss/fix-typedoc-outputs

branch
July 9, 2026 04:25
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jul 9, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments
@manovotnymanovotnymanovotny 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): Fix Typedoc outputs by SarahSoutoul · Pull Request #9101 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix Typedoc outputs - #9101
Merged
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Jul 9, 2026
Merged
docs(repo): Fix Typedoc outputs#9101
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jul 7, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This brings in fixes for broken output noticed here: https://github.com/clerk/clerk/pull/2881.
  • Add a TypeDoc LINK_REPLACEMENTS entry for protect-check-resource so generated ProtectCheckResource links resolve to /docs/reference/types/protect-check-resource
  • Add missing JSDoc descriptions for ProtectCheckResource.token, sdkUrl, and uiHints so the generated reference page includes those properties
  • Add an empty changeset for this docs/tooling-only update
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
Summary by CodeRabbit
  • Documentation
    • Updated reference link rewriting so links for the public resource now point to the correct docs page.
    • Expanded inline field documentation for ProtectCheckResource, including clearer descriptions for token and sdkUrl.
  • Chores
    • Added a changeset to track the documentation update.
@SarahSoutoulSarahSoutoul
self-assigned this
Jul 7, 2026
@vercel
vercelBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 7, 2026 4:50pm
swingsetReadyReadyPreview, CommentJul 7, 2026 4:50pm
Request Review
@changeset-bot
changeset-botBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 2d68d07
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
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
@coderabbitai
coderabbitaiBot
commented
Jul 7, 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 Plus
Run ID: 0def8084-6566-4a89-9e00-c285510beee9
📥 Commits
Reviewing files that changed from the base of the PR and between 521e752 and 2d68d07.
📒 Files selected for processing (1)
  • packages/shared/src/types/signUpCommon.ts
✅ Files skipped from review due to trivial changes (1)
  • packages/shared/src/types/signUpCommon.ts
📝 Walkthrough
Walkthrough
Adds JSDoc documentation to ProtectCheckResource properties, registers a TypeDoc link replacement for protect-check-resource, and adds a changeset file.
Changes
ProtectCheckResource Documentation and Link Mapping
Layer / File(s)Summary
JSDoc comments and link replacement
packages/shared/src/types/signUpCommon.ts, .typedoc/custom-plugin.mjs, .changeset/protect-check-typedoc-link.md		Adds explicit JSDoc blocks for token, sdkUrl, expiresAt, and uiHints in ProtectCheckResource, adds a LINK_REPLACEMENTS entry for protect-check-resource, and includes a new changeset file.
Estimated code review effort: 1 (Trivial) | ~3 minutes
Possibly related PRs
Poem
A bunny hops through docs so bright,

With links that point just right, just right.
token, sdkUrl got their say,

And protect-check-resource found its way.

A tidy changeset, snug and neat—

Nose twitch, thump thump, docs complete.
🚥 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 clearly matches the docs-focused TypeDoc link and output fixes in this changeset.
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.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@github-actions
github-actionsBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-07-07T16:52:01.899Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 2d68d07.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jul 7, 2026
View reviewed changes
@coderabbitaicoderabbitaiBot
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.

🧹 Nitpick comments (1)
packages/shared/src/types/signUpCommon.ts (1)
42-56: 🧹 Nitpick | 🔵 Trivial
Loop in Docs on this customer-facing JSDoc.
ProtectCheckResource is part of the TypeDoc entrypoint, so these comments will surface in generated reference docs. Please have the Docs team verify the wording and route alignment before merge.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/shared/src/types/signUpCommon.ts` around lines 42 - 56, The
customer-facing JSDoc on ProtectCheckResource in signUpCommon.ts will be
published in TypeDoc, so the wording and route alignment need Docs review before
merge. Please coordinate with the Docs team to verify and approve the comments
for token, sdkUrl, expiresAt, and the surrounding challenge hints section, and
update the text only if they request clarifications. Keep the public-facing
descriptions consistent with the generated reference docs entrypoint.

Source: Path instructions
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/shared/src/types/signUpCommon.ts`:
- Around line 42-56: The customer-facing JSDoc on ProtectCheckResource in
signUpCommon.ts will be published in TypeDoc, so the wording and route alignment
need Docs review before merge. Please coordinate with the Docs team to verify
and approve the comments for token, sdkUrl, expiresAt, and the surrounding
challenge hints section, and update the text only if they request
clarifications. Keep the public-facing descriptions consistent with the
generated reference docs entrypoint.

ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 01c85e02-c4e9-4de0-bad2-a261ab9567bc
📥 Commits
Reviewing files that changed from the base of the PR and between 6f97ef5 and 521e752.
📒 Files selected for processing (3)
  • .changeset/protect-check-typedoc-link.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/signUpCommon.ts
@pkg-pr-new
pkg-pr-newBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9101

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9101

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9101

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9101

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 2d68d07
manovotny
manovotny
reviewed
Jul 7, 2026
View reviewed changes
Comment thread.typedoc/custom-plugin.mjs
@wobsoriano
wobsoriano
merged commit a053917
into
mainJul 9, 2026

53 checks passed

@wobsoriano
wobsoriano
deleted the

ss/fix-typedoc-outputs

branch
July 9, 2026 04:25
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jul 9, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments
@manovotnymanovotnymanovotny 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): Fix Typedoc outputs by SarahSoutoul · Pull Request #9101 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix Typedoc outputs - #9101
Merged
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Jul 9, 2026
Merged
docs(repo): Fix Typedoc outputs#9101
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jul 7, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This brings in fixes for broken output noticed here: https://github.com/clerk/clerk/pull/2881.
  • Add a TypeDoc LINK_REPLACEMENTS entry for protect-check-resource so generated ProtectCheckResource links resolve to /docs/reference/types/protect-check-resource
  • Add missing JSDoc descriptions for ProtectCheckResource.token, sdkUrl, and uiHints so the generated reference page includes those properties
  • Add an empty changeset for this docs/tooling-only update
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
Summary by CodeRabbit
  • Documentation
    • Updated reference link rewriting so links for the public resource now point to the correct docs page.
    • Expanded inline field documentation for ProtectCheckResource, including clearer descriptions for token and sdkUrl.
  • Chores
    • Added a changeset to track the documentation update.
@SarahSoutoulSarahSoutoul
self-assigned this
Jul 7, 2026
@vercel
vercelBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 7, 2026 4:50pm
swingsetReadyReadyPreview, CommentJul 7, 2026 4:50pm
Request Review
@changeset-bot
changeset-botBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 2d68d07
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
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
@coderabbitai
coderabbitaiBot
commented
Jul 7, 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 Plus
Run ID: 0def8084-6566-4a89-9e00-c285510beee9
📥 Commits
Reviewing files that changed from the base of the PR and between 521e752 and 2d68d07.
📒 Files selected for processing (1)
  • packages/shared/src/types/signUpCommon.ts
✅ Files skipped from review due to trivial changes (1)
  • packages/shared/src/types/signUpCommon.ts
📝 Walkthrough
Walkthrough
Adds JSDoc documentation to ProtectCheckResource properties, registers a TypeDoc link replacement for protect-check-resource, and adds a changeset file.
Changes
ProtectCheckResource Documentation and Link Mapping
Layer / File(s)Summary
JSDoc comments and link replacement
packages/shared/src/types/signUpCommon.ts, .typedoc/custom-plugin.mjs, .changeset/protect-check-typedoc-link.md		Adds explicit JSDoc blocks for token, sdkUrl, expiresAt, and uiHints in ProtectCheckResource, adds a LINK_REPLACEMENTS entry for protect-check-resource, and includes a new changeset file.
Estimated code review effort: 1 (Trivial) | ~3 minutes
Possibly related PRs
Poem
A bunny hops through docs so bright,

With links that point just right, just right.
token, sdkUrl got their say,

And protect-check-resource found its way.

A tidy changeset, snug and neat—

Nose twitch, thump thump, docs complete.
🚥 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 clearly matches the docs-focused TypeDoc link and output fixes in this changeset.
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.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@github-actions
github-actionsBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-07-07T16:52:01.899Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 2d68d07.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jul 7, 2026
View reviewed changes
@coderabbitaicoderabbitaiBot
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.

🧹 Nitpick comments (1)
packages/shared/src/types/signUpCommon.ts (1)
42-56: 🧹 Nitpick | 🔵 Trivial
Loop in Docs on this customer-facing JSDoc.
ProtectCheckResource is part of the TypeDoc entrypoint, so these comments will surface in generated reference docs. Please have the Docs team verify the wording and route alignment before merge.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/shared/src/types/signUpCommon.ts` around lines 42 - 56, The
customer-facing JSDoc on ProtectCheckResource in signUpCommon.ts will be
published in TypeDoc, so the wording and route alignment need Docs review before
merge. Please coordinate with the Docs team to verify and approve the comments
for token, sdkUrl, expiresAt, and the surrounding challenge hints section, and
update the text only if they request clarifications. Keep the public-facing
descriptions consistent with the generated reference docs entrypoint.

Source: Path instructions
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/shared/src/types/signUpCommon.ts`:
- Around line 42-56: The customer-facing JSDoc on ProtectCheckResource in
signUpCommon.ts will be published in TypeDoc, so the wording and route alignment
need Docs review before merge. Please coordinate with the Docs team to verify
and approve the comments for token, sdkUrl, expiresAt, and the surrounding
challenge hints section, and update the text only if they request
clarifications. Keep the public-facing descriptions consistent with the
generated reference docs entrypoint.

ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 01c85e02-c4e9-4de0-bad2-a261ab9567bc
📥 Commits
Reviewing files that changed from the base of the PR and between 6f97ef5 and 521e752.
📒 Files selected for processing (3)
  • .changeset/protect-check-typedoc-link.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/signUpCommon.ts
@pkg-pr-new
pkg-pr-newBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9101

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9101

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9101

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9101

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 2d68d07
manovotny
manovotny
reviewed
Jul 7, 2026
View reviewed changes
Comment thread.typedoc/custom-plugin.mjs
@wobsoriano
wobsoriano
merged commit a053917
into
mainJul 9, 2026

53 checks passed

@wobsoriano
wobsoriano
deleted the

ss/fix-typedoc-outputs

branch
July 9, 2026 04:25
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jul 9, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments
@manovotnymanovotnymanovotny 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): Fix Typedoc outputs by SarahSoutoul · Pull Request #9101 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix Typedoc outputs - #9101
Merged
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Jul 9, 2026
Merged
docs(repo): Fix Typedoc outputs#9101
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jul 7, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This brings in fixes for broken output noticed here: https://github.com/clerk/clerk/pull/2881.
  • Add a TypeDoc LINK_REPLACEMENTS entry for protect-check-resource so generated ProtectCheckResource links resolve to /docs/reference/types/protect-check-resource
  • Add missing JSDoc descriptions for ProtectCheckResource.token, sdkUrl, and uiHints so the generated reference page includes those properties
  • Add an empty changeset for this docs/tooling-only update
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
Summary by CodeRabbit
  • Documentation
    • Updated reference link rewriting so links for the public resource now point to the correct docs page.
    • Expanded inline field documentation for ProtectCheckResource, including clearer descriptions for token and sdkUrl.
  • Chores
    • Added a changeset to track the documentation update.
@SarahSoutoulSarahSoutoul
self-assigned this
Jul 7, 2026
@vercel
vercelBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 7, 2026 4:50pm
swingsetReadyReadyPreview, CommentJul 7, 2026 4:50pm
Request Review
@changeset-bot
changeset-botBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 2d68d07
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
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
@coderabbitai
coderabbitaiBot
commented
Jul 7, 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 Plus
Run ID: 0def8084-6566-4a89-9e00-c285510beee9
📥 Commits
Reviewing files that changed from the base of the PR and between 521e752 and 2d68d07.
📒 Files selected for processing (1)
  • packages/shared/src/types/signUpCommon.ts
✅ Files skipped from review due to trivial changes (1)
  • packages/shared/src/types/signUpCommon.ts
📝 Walkthrough
Walkthrough
Adds JSDoc documentation to ProtectCheckResource properties, registers a TypeDoc link replacement for protect-check-resource, and adds a changeset file.
Changes
ProtectCheckResource Documentation and Link Mapping
Layer / File(s)Summary
JSDoc comments and link replacement
packages/shared/src/types/signUpCommon.ts, .typedoc/custom-plugin.mjs, .changeset/protect-check-typedoc-link.md		Adds explicit JSDoc blocks for token, sdkUrl, expiresAt, and uiHints in ProtectCheckResource, adds a LINK_REPLACEMENTS entry for protect-check-resource, and includes a new changeset file.
Estimated code review effort: 1 (Trivial) | ~3 minutes
Possibly related PRs
Poem
A bunny hops through docs so bright,

With links that point just right, just right.
token, sdkUrl got their say,

And protect-check-resource found its way.

A tidy changeset, snug and neat—

Nose twitch, thump thump, docs complete.
🚥 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 clearly matches the docs-focused TypeDoc link and output fixes in this changeset.
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.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@github-actions
github-actionsBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-07-07T16:52:01.899Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 2d68d07.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jul 7, 2026
View reviewed changes
@coderabbitaicoderabbitaiBot
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.

🧹 Nitpick comments (1)
packages/shared/src/types/signUpCommon.ts (1)
42-56: 🧹 Nitpick | 🔵 Trivial
Loop in Docs on this customer-facing JSDoc.
ProtectCheckResource is part of the TypeDoc entrypoint, so these comments will surface in generated reference docs. Please have the Docs team verify the wording and route alignment before merge.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/shared/src/types/signUpCommon.ts` around lines 42 - 56, The
customer-facing JSDoc on ProtectCheckResource in signUpCommon.ts will be
published in TypeDoc, so the wording and route alignment need Docs review before
merge. Please coordinate with the Docs team to verify and approve the comments
for token, sdkUrl, expiresAt, and the surrounding challenge hints section, and
update the text only if they request clarifications. Keep the public-facing
descriptions consistent with the generated reference docs entrypoint.

Source: Path instructions
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/shared/src/types/signUpCommon.ts`:
- Around line 42-56: The customer-facing JSDoc on ProtectCheckResource in
signUpCommon.ts will be published in TypeDoc, so the wording and route alignment
need Docs review before merge. Please coordinate with the Docs team to verify
and approve the comments for token, sdkUrl, expiresAt, and the surrounding
challenge hints section, and update the text only if they request
clarifications. Keep the public-facing descriptions consistent with the
generated reference docs entrypoint.

ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 01c85e02-c4e9-4de0-bad2-a261ab9567bc
📥 Commits
Reviewing files that changed from the base of the PR and between 6f97ef5 and 521e752.
📒 Files selected for processing (3)
  • .changeset/protect-check-typedoc-link.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/signUpCommon.ts
@pkg-pr-new
pkg-pr-newBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9101

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9101

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9101

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9101

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 2d68d07
manovotny
manovotny
reviewed
Jul 7, 2026
View reviewed changes
Comment thread.typedoc/custom-plugin.mjs
@wobsoriano
wobsoriano
merged commit a053917
into
mainJul 9, 2026

53 checks passed

@wobsoriano
wobsoriano
deleted the

ss/fix-typedoc-outputs

branch
July 9, 2026 04:25
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jul 9, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments
@manovotnymanovotnymanovotny 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): Fix Typedoc outputs by SarahSoutoul · Pull Request #9101 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix Typedoc outputs - #9101
Merged
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Jul 9, 2026
Merged
docs(repo): Fix Typedoc outputs#9101
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jul 7, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This brings in fixes for broken output noticed here: https://github.com/clerk/clerk/pull/2881.
  • Add a TypeDoc LINK_REPLACEMENTS entry for protect-check-resource so generated ProtectCheckResource links resolve to /docs/reference/types/protect-check-resource
  • Add missing JSDoc descriptions for ProtectCheckResource.token, sdkUrl, and uiHints so the generated reference page includes those properties
  • Add an empty changeset for this docs/tooling-only update
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
Summary by CodeRabbit
  • Documentation
    • Updated reference link rewriting so links for the public resource now point to the correct docs page.
    • Expanded inline field documentation for ProtectCheckResource, including clearer descriptions for token and sdkUrl.
  • Chores
    • Added a changeset to track the documentation update.
@SarahSoutoulSarahSoutoul
self-assigned this
Jul 7, 2026
@vercel
vercelBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 7, 2026 4:50pm
swingsetReadyReadyPreview, CommentJul 7, 2026 4:50pm
Request Review
@changeset-bot
changeset-botBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 2d68d07
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
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
@coderabbitai
coderabbitaiBot
commented
Jul 7, 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 Plus
Run ID: 0def8084-6566-4a89-9e00-c285510beee9
📥 Commits
Reviewing files that changed from the base of the PR and between 521e752 and 2d68d07.
📒 Files selected for processing (1)
  • packages/shared/src/types/signUpCommon.ts
✅ Files skipped from review due to trivial changes (1)
  • packages/shared/src/types/signUpCommon.ts
📝 Walkthrough
Walkthrough
Adds JSDoc documentation to ProtectCheckResource properties, registers a TypeDoc link replacement for protect-check-resource, and adds a changeset file.
Changes
ProtectCheckResource Documentation and Link Mapping
Layer / File(s)Summary
JSDoc comments and link replacement
packages/shared/src/types/signUpCommon.ts, .typedoc/custom-plugin.mjs, .changeset/protect-check-typedoc-link.md		Adds explicit JSDoc blocks for token, sdkUrl, expiresAt, and uiHints in ProtectCheckResource, adds a LINK_REPLACEMENTS entry for protect-check-resource, and includes a new changeset file.
Estimated code review effort: 1 (Trivial) | ~3 minutes
Possibly related PRs
Poem
A bunny hops through docs so bright,

With links that point just right, just right.
token, sdkUrl got their say,

And protect-check-resource found its way.

A tidy changeset, snug and neat—

Nose twitch, thump thump, docs complete.
🚥 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 clearly matches the docs-focused TypeDoc link and output fixes in this changeset.
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.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@github-actions
github-actionsBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-07-07T16:52:01.899Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 2d68d07.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jul 7, 2026
View reviewed changes
@coderabbitaicoderabbitaiBot
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.

🧹 Nitpick comments (1)
packages/shared/src/types/signUpCommon.ts (1)
42-56: 🧹 Nitpick | 🔵 Trivial
Loop in Docs on this customer-facing JSDoc.
ProtectCheckResource is part of the TypeDoc entrypoint, so these comments will surface in generated reference docs. Please have the Docs team verify the wording and route alignment before merge.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/shared/src/types/signUpCommon.ts` around lines 42 - 56, The
customer-facing JSDoc on ProtectCheckResource in signUpCommon.ts will be
published in TypeDoc, so the wording and route alignment need Docs review before
merge. Please coordinate with the Docs team to verify and approve the comments
for token, sdkUrl, expiresAt, and the surrounding challenge hints section, and
update the text only if they request clarifications. Keep the public-facing
descriptions consistent with the generated reference docs entrypoint.

Source: Path instructions
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/shared/src/types/signUpCommon.ts`:
- Around line 42-56: The customer-facing JSDoc on ProtectCheckResource in
signUpCommon.ts will be published in TypeDoc, so the wording and route alignment
need Docs review before merge. Please coordinate with the Docs team to verify
and approve the comments for token, sdkUrl, expiresAt, and the surrounding
challenge hints section, and update the text only if they request
clarifications. Keep the public-facing descriptions consistent with the
generated reference docs entrypoint.

ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 01c85e02-c4e9-4de0-bad2-a261ab9567bc
📥 Commits
Reviewing files that changed from the base of the PR and between 6f97ef5 and 521e752.
📒 Files selected for processing (3)
  • .changeset/protect-check-typedoc-link.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/signUpCommon.ts
@pkg-pr-new
pkg-pr-newBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9101

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9101

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9101

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9101

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 2d68d07
manovotny
manovotny
reviewed
Jul 7, 2026
View reviewed changes
Comment thread.typedoc/custom-plugin.mjs
@wobsoriano
wobsoriano
merged commit a053917
into
mainJul 9, 2026

53 checks passed

@wobsoriano
wobsoriano
deleted the

ss/fix-typedoc-outputs

branch
July 9, 2026 04:25
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jul 9, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments
@manovotnymanovotnymanovotny 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): Fix Typedoc outputs by SarahSoutoul · Pull Request #9101 · clerk/javascript · GitHub
Skip to content
docs(repo): Fix Typedoc outputs - #9101
Merged
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Jul 9, 2026
Merged
docs(repo): Fix Typedoc outputs#9101
wobsoriano merged 2 commits into
mainfrom 
ss/fix-typedoc-outputs
Conversation
@SarahSoutoul
@SarahSoutoulSarahSoutoul
commented
Jul 7, 2026•

edited by coderabbitai
Bot
Loading

Copy link


Copy Markdown

Contributor
Description
This brings in fixes for broken output noticed here: https://github.com/clerk/clerk/pull/2881.
  • Add a TypeDoc LINK_REPLACEMENTS entry for protect-check-resource so generated ProtectCheckResource links resolve to /docs/reference/types/protect-check-resource
  • Add missing JSDoc descriptions for ProtectCheckResource.token, sdkUrl, and uiHints so the generated reference page includes those properties
  • Add an empty changeset for this docs/tooling-only update
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
Summary by CodeRabbit
  • Documentation
    • Updated reference link rewriting so links for the public resource now point to the correct docs page.
    • Expanded inline field documentation for ProtectCheckResource, including clearer descriptions for token and sdkUrl.
  • Chores
    • Added a changeset to track the documentation update.
@SarahSoutoulSarahSoutoul
self-assigned this
Jul 7, 2026
@vercel
vercelBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.
ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 7, 2026 4:50pm
swingsetReadyReadyPreview, CommentJul 7, 2026 4:50pm
Request Review
@changeset-bot
changeset-botBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

🦋 Changeset detected
Latest commit: 2d68d07
The changes in this PR will be included in the next version bump.
This PR includes changesets to release 0 packages
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
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
@coderabbitai
coderabbitaiBot
commented
Jul 7, 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 Plus
Run ID: 0def8084-6566-4a89-9e00-c285510beee9
📥 Commits
Reviewing files that changed from the base of the PR and between 521e752 and 2d68d07.
📒 Files selected for processing (1)
  • packages/shared/src/types/signUpCommon.ts
✅ Files skipped from review due to trivial changes (1)
  • packages/shared/src/types/signUpCommon.ts
📝 Walkthrough
Walkthrough
Adds JSDoc documentation to ProtectCheckResource properties, registers a TypeDoc link replacement for protect-check-resource, and adds a changeset file.
Changes
ProtectCheckResource Documentation and Link Mapping
Layer / File(s)Summary
JSDoc comments and link replacement
packages/shared/src/types/signUpCommon.ts, .typedoc/custom-plugin.mjs, .changeset/protect-check-typedoc-link.md		Adds explicit JSDoc blocks for token, sdkUrl, expiresAt, and uiHints in ProtectCheckResource, adds a LINK_REPLACEMENTS entry for protect-check-resource, and includes a new changeset file.
Estimated code review effort: 1 (Trivial) | ~3 minutes
Possibly related PRs
Poem
A bunny hops through docs so bright,

With links that point just right, just right.
token, sdkUrl got their say,

And protect-check-resource found its way.

A tidy changeset, snug and neat—

Nose twitch, thump thump, docs complete.
🚥 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 clearly matches the docs-focused TypeDoc link and output fixes in this changeset.
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.
✨ Finishing Touches
📝 Generate docstrings
  •  Create stacked PR
  •  Commit on current branch
Comment @coderabbitai help to get the list of available commands.
@github-actions
github-actionsBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Contributor
API Changes Report
Generated by Break Check on 2026-07-07T16:52:01.899Z
Summary
MetricCount
Packages analyzed19
Packages with changes0
🔴 Breaking changes0
🟡 Non-breaking changes0
🟢 Additions0
No API Changes Detected
All packages have stable APIs with no detected changes.
Report generated by Break Check
Last ran on 2d68d07.
coderabbitai[bot]
coderabbitaiBot
reviewed
Jul 7, 2026
View reviewed changes
@coderabbitaicoderabbitaiBot
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.

🧹 Nitpick comments (1)
packages/shared/src/types/signUpCommon.ts (1)
42-56: 🧹 Nitpick | 🔵 Trivial
Loop in Docs on this customer-facing JSDoc.
ProtectCheckResource is part of the TypeDoc entrypoint, so these comments will surface in generated reference docs. Please have the Docs team verify the wording and route alignment before merge.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/shared/src/types/signUpCommon.ts` around lines 42 - 56, The
customer-facing JSDoc on ProtectCheckResource in signUpCommon.ts will be
published in TypeDoc, so the wording and route alignment need Docs review before
merge. Please coordinate with the Docs team to verify and approve the comments
for token, sdkUrl, expiresAt, and the surrounding challenge hints section, and
update the text only if they request clarifications. Keep the public-facing
descriptions consistent with the generated reference docs entrypoint.

Source: Path instructions
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@packages/shared/src/types/signUpCommon.ts`:
- Around line 42-56: The customer-facing JSDoc on ProtectCheckResource in
signUpCommon.ts will be published in TypeDoc, so the wording and route alignment
need Docs review before merge. Please coordinate with the Docs team to verify
and approve the comments for token, sdkUrl, expiresAt, and the surrounding
challenge hints section, and update the text only if they request
clarifications. Keep the public-facing descriptions consistent with the
generated reference docs entrypoint.

ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Repository UI (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 01c85e02-c4e9-4de0-bad2-a261ab9567bc
📥 Commits
Reviewing files that changed from the base of the PR and between 6f97ef5 and 521e752.
📒 Files selected for processing (3)
  • .changeset/protect-check-typedoc-link.md
  • .typedoc/custom-plugin.mjs
  • packages/shared/src/types/signUpCommon.ts
@pkg-pr-new
pkg-pr-newBot
commented
Jul 7, 2026•

edited

Loading

Copy link


Copy Markdown

Open in StackBlitz
@clerk/astro
npm i https://pkg.pr.new/@clerk/astro@9101

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

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

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

@clerk/electron
npm i https://pkg.pr.new/@clerk/electron@9101

@clerk/electron-passkeys
npm i https://pkg.pr.new/@clerk/electron-passkeys@9101

@clerk/eslint-plugin
npm i https://pkg.pr.new/@clerk/eslint-plugin@9101

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

commit: 2d68d07
manovotny
manovotny
reviewed
Jul 7, 2026
View reviewed changes
Comment thread.typedoc/custom-plugin.mjs
@wobsoriano
wobsoriano
merged commit a053917
into
mainJul 9, 2026

53 checks passed

@wobsoriano
wobsoriano
deleted the

ss/fix-typedoc-outputs

branch
July 9, 2026 04:25
@coderabbitaicoderabbitaiBot
mentioned this pull request
Jul 9, 2026
 Merged

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

Reviewers

@coderabbitaicoderabbitai[bot]coderabbitai[bot] left review comments
@manovotnymanovotnymanovotny 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