Skip to content

Conversation

@SarahSoutoul
Copy link
Contributor

@SarahSoutoul SarahSoutoul commented Dec 1, 2025

Description

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 in-app documentation references to point users to the verified domains / domain enrollment settings page.
  • Chores

    • Added release metadata entry to track this update.

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

@SarahSoutoul SarahSoutoul self-assigned this Dec 1, 2025
@changeset-bot
Copy link

changeset-bot bot commented Dec 1, 2025

🦋 Changeset detected

Latest commit: a6c4b79

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

@vercel
Copy link

vercel bot commented Dec 1, 2025

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

Project Deployment Preview Comments Updated (UTC)
clerk-js-sandbox Ready Ready Preview Comment Dec 1, 2025 9:09pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 1, 2025

Walkthrough

Two JSDoc comment updates across the backend API endpoint and shared React hooks packages redirect documentation references from the enrollment-mode anchor to the enable-verified-domains anchor. A new changeset file was added. No functional code changes or signature modifications.

Changes

Cohort / File(s) Summary
JSDoc documentation link updates
packages/backend/src/api/endpoints/InstanceApi.ts, packages/shared/src/react/hooks/useOrganization.tsx
Updated JSDoc links changing the Clerk docs anchor from enrollment-mode to enable-verified-domains. No code, type, or signature changes.
New changeset file
.changeset/gentle-humans-arrive.md
Added a new changeset markdown file containing YAML document separators. No functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Files to spot-check: the two JSDoc comment lines in InstanceApi.ts and useOrganization.tsx, and the new .changeset/gentle-humans-arrive.md file.

Poem

🐰 I hopped through comments, keen and bright,
Swapped a link to guide the light,
Dropped a changeset, tidy, small,
A tiny change — I cheer it all!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The PR updates documentation links related to verified domains but does not address the core requirement to verify/test email notification behavior or document email notifications in addition to org profile notifications. Verify that verified-domain membership requests send email notifications and ensure appropriate tests cover this behavior, then update documentation to document both email and in-app notifications.
✅ Passed checks (4 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 documentation links from enrollment-mode to enable-verified-domains across multiple files.
Out of Scope Changes check ✅ Passed All changes (documentation link updates in two files and a changeset file) are directly related to updating clerk-docs references for verified domains, which is within scope of the documentation link refactoring objective.
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 ss/DOCS-10980

📜 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 aa77153 and a6c4b79.

📒 Files selected for processing (1)
  • .changeset/gentle-humans-arrive.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • .changeset/gentle-humans-arrive.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). (34)
  • GitHub Check: Integration Tests (expo-web, chrome)
  • GitHub Check: Integration Tests (quickstart, chrome, 16)
  • GitHub Check: Integration Tests (quickstart, chrome, 15)
  • GitHub Check: Integration Tests (express, chrome)
  • GitHub Check: Integration Tests (billing, chrome, RQ)
  • GitHub Check: Integration Tests (astro, chrome)
  • GitHub Check: Integration Tests (tanstack-react-start, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 15, RQ)
  • GitHub Check: Integration Tests (sessions:staging, chrome)
  • GitHub Check: Integration Tests (ap-flows, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 16)
  • GitHub Check: Integration Tests (handshake, chrome)
  • GitHub Check: Integration Tests (machine, chrome)
  • GitHub Check: Integration Tests (elements, chrome)
  • GitHub Check: Integration Tests (billing, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 15)
  • GitHub Check: Integration Tests (nextjs, chrome, 14)
  • GitHub Check: Integration Tests (machine, chrome, RQ)
  • GitHub Check: Integration Tests (vue, chrome)
  • GitHub Check: Integration Tests (nuxt, chrome)
  • GitHub Check: Integration Tests (react-router, chrome)
  • GitHub Check: Integration Tests (custom, chrome)
  • GitHub Check: Integration Tests (handshake:staging, chrome)
  • GitHub Check: Integration Tests (localhost, chrome)
  • GitHub Check: Integration Tests (sessions, chrome)
  • GitHub Check: Integration Tests (generic, chrome)
  • GitHub Check: Unit Tests (22, shared, clerk-js, RQ)
  • GitHub Check: Publish with pkg-pr-new
  • GitHub Check: Unit Tests (22, **)
  • GitHub Check: Static analysis
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: semgrep-cloud-platform/scan
  • 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 1, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: a6c4b79

@SarahSoutoul SarahSoutoul merged commit f95ffdc into main Dec 1, 2025
45 of 46 checks passed
@SarahSoutoul SarahSoutoul deleted the ss/DOCS-10980 branch December 1, 2025 23:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants