Skip to content

fix(backend): point lockUser() JSDoc to canonical System Dashboard link - #9691

Merged
manovotny merged 1 commit into
mainfrom
docs/lockuser-protect-rules-system-link
Sep 11, 2026
Merged

manovotny merged 1 commit into
mainfrom
docs/lockuser-protect-rules-system-link

Conversation

@manovotny

Copy link
Copy Markdown
Contributor

The Dashboard's Protect navigation moved Rules under a System / Custom split, so the old /~/protect/rules target now redirects. This updates the lockUser() JSDoc to point at the System page (/~/protect/rules/system) under Protect > Rules.

This is the last occurrence of the old link — the hand-authored docs are handled in clerk/clerk#3319, but the lockUser() reference at clerk-docs/clerk-typedoc/backend/user-api/methods/lock-user.mdx is generated from this JSDoc, so the fix has to land here and flow back through the Typedoc refresh.

Context

  • Docs link updates: clerk/clerk#3319
  • Dashboard nav change: clerk/dashboard#10173

The Dashboard's Protect navigation moved Rules under a System/Custom split,
so the old /~/protect/rules target now redirects. Point the lockUser() JSDoc
at the System page (/~/protect/rules/system) under Protect > Rules to match.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 9, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated
clerk-js-sandbox Ready Ready Preview Sep 9, 2026 3:54pm UTC
swingset Ready Ready Preview Sep 9, 2026 3:54pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Sep 9, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 7fdf3c2

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

This PR includes changesets to release 10 packages
Name Type
@clerk/backend Patch
@clerk/astro Patch
@clerk/express Patch
@clerk/fastify Patch
@clerk/hono Patch
@clerk/nextjs Patch
@clerk/nuxt Patch
@clerk/react-router Patch
@clerk/tanstack-react-start Patch
@clerk/testing 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

@coderabbitai

coderabbitai Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: ASSERTIVE

Plan: Team

Run ID: 74c94e75-c1d7-4d54-a97f-dd52439f8dee

📥 Commits

Reviewing files that changed from the base of the PR and between a13ffd9 and 7fdf3c2.

📒 Files selected for processing (2)
  • .changeset/lockuser-protect-rules-system-link.md
  • packages/backend/src/api/endpoints/UserApi.ts
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

Included review availability: 3 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 8 reviews per hour.


📝 Walkthrough

Walkthrough

The lockUser() JSDoc now links to the Protect > Rules > System documentation path. A patch changeset records the documentation update for @clerk/backend. No runtime behavior or public entity declarations changed.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to 7fdf3

The lockUser() documentation now directs users to the Protect Rules System page rather than the redirecting legacy location. No production behavior changes are included, and no current merge-readiness risk remains.

Suggested reviewers: sarahsoutoul, dmoerner, alexisintech

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly explains the JSDoc link update, the Dashboard navigation change, and the generated Typedoc impact.
Title check ✅ Passed The title clearly identifies the backend JSDoc change and the updated canonical Dashboard link.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Warning

Linked repositories: Your configuration references 7 linked repositories, but your current plan allows 5. Analyzed clerk/clerk_go, clerk/dashboard, clerk/accounts, clerk/backoffice, clerk/clerk, skipped clerk/clerk-docs, clerk/cloudflare-workers.


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

@pkg-pr-new

pkg-pr-new Bot commented Sep 9, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9691

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 7fdf3c2

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-09-09T15:57:08.658Z

Summary

Metric Count
Packages analyzed 19
Packages with changes 0
🔴 Breaking changes 0
🟡 Non-breaking changes 0
🟢 Additions 0

No API Changes Detected

All packages have stable APIs with no detected changes.


Report generated by Break Check

Last ran on 7fdf3c2.

@manovotny
manovotny enabled auto-merge (squash) September 11, 2026 15:49
@manovotny
manovotny merged commit 4e1e432 into main Sep 11, 2026
86 of 94 checks passed
@manovotny
manovotny deleted the docs/lockuser-protect-rules-system-link branch September 11, 2026 15:52
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.

2 participants