Skip to content

Conversation

@alexisintech
Copy link
Member

@alexisintech alexisintech commented Dec 16, 2025

Description

Updates Docs links in comments

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Summary by CodeRabbit

  • Documentation
    • Updated reference links in type definitions and user docs to point to current overview and guides pages.
    • Added a changeset noting these documentation link updates (patch release).

✏️ Tip: You can customize this high-level summary in your review settings.

@vercel
Copy link

vercel bot commented Dec 16, 2025

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

Project Deployment Review Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment Dec 16, 2025 7:07pm

@changeset-bot
Copy link

changeset-bot bot commented Dec 16, 2025

🦋 Changeset detected

Latest commit: 4f54a51

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

This PR includes changesets to release 19 packages
Name Type
@clerk/react Patch
@clerk/shared Patch
@clerk/chrome-extension Patch
@clerk/expo Patch
@clerk/nextjs Patch
@clerk/react-router Patch
@clerk/tanstack-react-start Patch
@clerk/agent-toolkit Patch
@clerk/astro Patch
@clerk/backend Patch
@clerk/clerk-js Patch
@clerk/expo-passkeys Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/localizations Patch
@clerk/nuxt Patch
@clerk/testing Patch
@clerk/ui Patch
@clerk/vue Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@alexisintech alexisintech changed the title chore(react/shared): update reference links in comments chore(react/shared): Update reference links in comments Dec 16, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 16, 2025

Walkthrough

Small documentation-only edits: JSDoc/comments in type files updated to point to revised URLs and a changeset file added. No type signatures, runtime behavior, or API changes.

Changes

Cohort / File(s) Summary
Type JSDoc updates
packages/react/src/types.ts, packages/shared/src/types/clerk.ts, packages/shared/src/types/user.ts
Updated JSDoc and inline documentation URLs: ClerkProviderProps.appearance now references the overview subpath; ClerkOptions.appearance points to the Guides path; User social providers link changed from /all-providers to /overview. No type or runtime changes.
Release metadata
.changeset/purple-kiwis-work.md
Added changeset declaring patch bumps for @clerk/react and @clerk/shared with note "Updated reference links in comments."

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Changes are cosmetic documentation edits and a new changeset file.
  • Review focus: confirm only comment text and the added changeset; no code, types, or behavior modified.

Poem

🐰 I hopped through comments, soft and spry,
I nudged the links to where they fly,
Guides and overviews now in view,
A tiny patch — fresh, clear, and true,
Hop, click, and onward — documentation anew! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating reference links in comments across react and shared packages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch aa/update-links-in-comments

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between cc678a5 and e05b411.

📒 Files selected for processing (1)
  • .changeset/purple-kiwis-work.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changeset/purple-kiwis-work.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (25)
  • GitHub Check: Integration Tests (nextjs, chrome, 16)
  • GitHub Check: Integration Tests (billing, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 15)
  • GitHub Check: Integration Tests (localhost, chrome)
  • GitHub Check: Integration Tests (ap-flows, chrome)
  • GitHub Check: Integration Tests (tanstack-react-start, chrome)
  • GitHub Check: Integration Tests (machine, chrome)
  • GitHub Check: Integration Tests (custom, chrome)
  • GitHub Check: Integration Tests (quickstart, chrome, 15)
  • GitHub Check: Integration Tests (machine, chrome, RQ)
  • GitHub Check: Integration Tests (nextjs, chrome, 16, RQ)
  • GitHub Check: Integration Tests (billing, chrome, RQ)
  • GitHub Check: Integration Tests (vue, chrome)
  • GitHub Check: Integration Tests (generic, chrome)
  • GitHub Check: Integration Tests (handshake, chrome)
  • GitHub Check: Integration Tests (quickstart, chrome, 16)
  • GitHub Check: Integration Tests (astro, chrome)
  • GitHub Check: Integration Tests (react-router, chrome)
  • GitHub Check: Integration Tests (nuxt, chrome)
  • GitHub Check: Integration Tests (handshake:staging, chrome)
  • GitHub Check: Integration Tests (express, chrome)
  • GitHub Check: Integration Tests (sessions:staging, chrome)
  • GitHub Check: Integration Tests (sessions, chrome)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: semgrep-cloud-platform/scan

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
Copy link

pkg-pr-new bot commented Dec 16, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 4f54a51

@wobsoriano wobsoriano changed the title chore(react/shared): Update reference links in comments chore(react,shared): Update reference links in comments Dec 16, 2025
@alexisintech alexisintech enabled auto-merge (squash) December 16, 2025 19:06
@alexisintech
Copy link
Member Author

@wobsoriano oof how do we get those pesky ci tests to pass?

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants