docs(backend,shared): Update typedoc comments #7115

alexisintech · 2025-10-31T18:29:52Z

Description

Updating links in typedoc comments, related to this docs PR: clerk/clerk-docs#2758

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

changeset-bot · 2025-10-31T18:29:56Z

⚠️ No Changeset found

Latest commit: 1ce0990

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 · 2025-10-31T18:29:57Z

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

Project	Deployment	Preview	Comments	Updated (UTC)
clerk-js-sandbox	Ready	Preview	Comment	Nov 21, 2025 11:29pm

coderabbitai · 2025-10-31T18:30:04Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch im2nguyen/refactor-org-docs

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

Provide your own instructions using the high_level_summary_instructions setting.
Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

📝 Description — Summarize the main change in 50–60 words, explaining what was done.

📓 References — List relevant issues, discussions, documentation, or related PRs.

📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.

📊 Contributor Summary — Include a Markdown table showing contributions:
| Contributor | Lines Added | Lines Removed | Files Changed |

✔️ Additional Notes — Add any extra reviewer context.
Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

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

pkg-pr-new · 2025-10-31T18:33:52Z

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 658eaa0

blacksmith-sh · 2025-10-31T18:38:24Z

Found 22 test failures on Blacksmith runners:

Test	View Logs
`[chrome] › integration/tests/elements/` `next-sign-in.test.ts:134:7 › Next.js Sign-In Flow @elements › long-running--elements.ne` `xt.appRouter › can reset password`	View Logs
`[chrome] › integration/tests/elements/` `next-sign-up.test.ts:89:7 › Next.js Sign-Up Flow @elements › long-running--elements.nex` `t.appRouter › can sign up with phone number`	View Logs
`[chrome] › integration/tests/elements/` `otp.test.ts:196:9 › OTP @elements › long-running--elements.next.appRouter › Type: segme` `nted-otp › should forward-delete char when pressing delete`	View Logs
`[chrome] › integration/tests/` `pricing-table.test.ts:110:9 › pricing table @billing › long-running--withBilling.astro.` `node › when signed in flow › subscribes to a plan`	View Logs
`[chrome] › integration/tests/` `pricing-table.test.ts:110:9 › pricing table @billing › long-running--withBilling.next.a` `ppRouter › when signed in flow › subscribes to a plan`	View Logs
`[chrome] › integration/tests/` `pricing-table.test.ts:110:9 › pricing table @billing › long-running--withBilling.vue.vi` `te › when signed in flow › subscribes to a plan`	View Logs
`[chrome] › integration/tests/` `pricing-table.test.ts:250:7 › pricing table @billing › long-running--withBilling.astro.` `node › starts free trial subscription for new user`	View Logs
`[chrome] › integration/tests/` `pricing-table.test.ts:250:7 › pricing table @billing › long-running--withBilling.next.a` `ppRouter › starts free trial subscription for new user`	View Logs
`[chrome] › integration/tests/` `pricing-table.test.ts:385:7 › pricing table @billing › long-running--withBilling.next.a` `ppRouter › subscribing to other paid plans while on free trial is immediate cancellatio` `n`	View Logs
`[chrome] › integration/tests/` `pricing-table.test.ts:456:9 › pricing table @billing › long-running--withBilling.vue.vi` `te › in UserProfile › renders pricing table, subscribes to a plan, revalidates payment` `method on complete and then downgrades to free`	View Logs
`[chrome] › integration/tests/` `pricing-table.test.ts:588:9 › pricing table @billing › long-running--withBilling.next.a` `ppRouter › in UserProfile › adds payment method via checkout and resets stripe setup in` `tent after failed payment`	View Logs
`[chrome] › integration/tests/` `protect.test.ts:38:7 › authorization @nextjs › long-running--next.appRouter.withCustomR` `oles › Protect in RSCs and RCCs as admin`	View Logs
`[chrome] › integration/tests/` `session-tasks-multi-session.test.ts:33:9 › session tasks multi-session flow @nextjs › l` `ong-running--next.appRouter.withSessionTasks › when switching sessions, navigate to tas` `k`	View Logs
`[chrome] › integration/tests/` `session-tasks-multi-session.test.ts:33:9 › session tasks multi-session flow @nextjs › l` `ong-running--next.appRouter.withSessionTasks › when switching sessions, navigate to tas` `k`	View Logs
`[chrome] › integration/tests/` `sign-in-flow.test.ts:101:7 › sign in flow @generic @nextjs › long-running--next.appRout` `er.withEmailCodes › can reset password`	View Logs
`[chrome] › integration/tests/` `sign-in-flow.test.ts:101:7 › sign in flow @generic @nextjs › long-running--next.appRout` `er.withEmailCodes › can reset password`	View Logs
`[chrome] › integration/tests/` `sign-in-flow.test.ts:101:7 › sign in flow @generic @nextjs › long-running--next.appRout` `er.withEmailCodes › can reset password`	View Logs
`[chrome] › integration/tests/` `sign-in-flow.test.ts:101:7 › sign in flow @generic @nextjs › long-running--next.appRout` `er.withEmailCodes › can reset password`	View Logs
`[chrome] › integration/tests/` `sign-in-flow.test.ts:101:7 › sign in flow @generic @nextjs › long-running--react.vite.w` `ithEmailCodes › can reset password`	View Logs
`[chrome] › integration/tests/` `sign-in-or-up-flow.test.ts:115:9 › sign-in-or-up flow @nextjs › long-running--next.appR` `outer.withSignInOrUpFlow › sign-in › can reset password`	View Logs
`[chrome] › integration/tests/` `sign-in-or-up-flow.test.ts:115:9 › sign-in-or-up flow @nextjs › long-running--next.appR` `outer.withSignInOrUpFlow › sign-in › can reset password`	View Logs
`[chrome] › integration/tests/` `sign-in-or-up-flow.test.ts:115:9 › sign-in-or-up flow @nextjs › long-running--next.appR` `outer.withSignInOrUpFlow › sign-in › can reset password`	View Logs

SarahSoutoul · 2025-11-11T17:43:17Z

@alexisintech have updated the links after they got changed in the clerk-docs PR: Update links. Reduces the nb of files changed massively as a result.

docs(backend/shared): Update typedoc comments

658eaa0

alexisintech marked this pull request as draft October 31, 2025 18:29

clerk-cookie added the backend label Oct 31, 2025

alexisintech mentioned this pull request Oct 31, 2025

Reorganize and restructure Organization docs clerk/clerk-docs#2758

Open

2 tasks

SarahSoutoul added 2 commits November 11, 2025 11:37

Merge branch 'main' into im2nguyen/refactor-org-docs

c08164d

Update links

f95a30c

clerk-cookie removed the backend label Nov 11, 2025

vercel bot deployed to Preview November 11, 2025 17:43 View deployment

Merge branch 'main' into im2nguyen/refactor-org-docs

24a5356

vercel bot deployed to Preview November 12, 2025 18:47 View deployment

Merge branch 'main' into im2nguyen/refactor-org-docs

c9cada5

vercel bot deployed to Preview November 18, 2025 16:08 View deployment

update links and capitalizaitons

1ce0990

clerk-cookie added clerk-js react backend astro react-router agent-toolkit labels Nov 21, 2025

vercel bot deployed to Preview November 21, 2025 23:29 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(backend,shared): Update typedoc comments #7115

docs(backend,shared): Update typedoc comments #7115

Uh oh!

alexisintech commented Oct 31, 2025

Uh oh!

changeset-bot bot commented Oct 31, 2025 •

edited

Loading

Uh oh!

vercel bot commented Oct 31, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Oct 31, 2025 •

edited

Loading

Review skipped

Uh oh!

pkg-pr-new bot commented Oct 31, 2025

Uh oh!

blacksmith-sh bot commented Oct 31, 2025 •

edited

Loading

Uh oh!

SarahSoutoul commented Nov 11, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

docs(backend,shared): Update typedoc comments #7115

Are you sure you want to change the base?

docs(backend,shared): Update typedoc comments #7115

Uh oh!

Conversation

alexisintech commented Oct 31, 2025

Description

Checklist

Type of change

Uh oh!

changeset-bot bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

vercel bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

pkg-pr-new bot commented Oct 31, 2025

Uh oh!

blacksmith-sh bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SarahSoutoul commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

changeset-bot bot commented Oct 31, 2025 •

edited

Loading

vercel bot commented Oct 31, 2025 •

edited

Loading

coderabbitai bot commented Oct 31, 2025 •

edited

Loading

blacksmith-sh bot commented Oct 31, 2025 •

edited

Loading

SarahSoutoul commented Nov 11, 2025 •

edited

Loading