Skip to content

docs(backend): Use root-relative link for passwordHasher contact support reference - #9347

Open
manovotny wants to merge 1 commit into
mainfrom
michael/backend-relative-contact-support-link
Open

docs(backend): Use root-relative link for passwordHasher contact support reference#9347
manovotny wants to merge 1 commit into
mainfrom
michael/backend-relative-contact-support-link

Conversation

@manovotny

Copy link
Copy Markdown
Contributor

Description

The passwordHasher param JSDoc in packages/backend/src/api/endpoints/UserApi.ts used an absolute https://clerk.com/contact/support link. The docs renderer (MDXLink.tsx) treats absolute http(s):// links as external — opening a new tab with an external-link icon — whereas root-relative links are internal same-tab.

The Typedoc replace-text plugin only relativizes https://clerk.com/docs links, so this was the one non-/docs clerk.com link in the backend source and it leaked through as external. Switching it to /contact/support matches the convention already used for the /docs/... links authored directly in this same file.

UserPasswordHashingParams is shared by both CreateUserParams and UpdateUserParams, so this single change corrects all three generated files in clerk/clerk (create-user-params.mdx, user-api/methods/create-user.mdx, user-api/methods/update-user.mdx) on the next Typedoc sync.

This is the upstream counterpart to the support-link normalization done in clerk/clerk #3101, and a continuation of #9340.

Testing

Regenerated the backend Typedoc locally and confirmed the generated output now emits [contact support](/contact/support) with no remaining absolute clerk.com/contact link.

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:

…ort reference

The `passwordHasher` JSDoc used an absolute https://clerk.com/contact/support
link, which the docs renderer treats as external (new tab + external-link icon).
The typedoc replace-text plugin only relativizes /docs links, so this one leaked
through. Root-relative /contact/support renders as an internal same-tab link,
matching the convention already used for /docs links in this file and the
normalization done in clerk/clerk #3101.

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

vercel Bot commented Aug 6, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview Aug 6, 2026 1:45am
swingset Ready Ready Preview Aug 6, 2026 1:45am

Request Review

@changeset-bot

changeset-bot Bot commented Aug 6, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 1b77872

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

@pkg-pr-new

pkg-pr-new Bot commented Aug 6, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 1b77872

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-08-06T01:48:57.350Z

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 1b77872.

@coderabbitai

coderabbitai Bot commented Aug 6, 2026

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), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: 24cb11f7-56bc-4b98-bf6b-86e7f80c0ea0

📥 Commits

Reviewing files that changed from the base of the PR and between 58d8ff5 and 1b77872.

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

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

  • clerk/clerk_go (manual)
  • clerk/dashboard (manual)
  • clerk/accounts (manual)
  • clerk/backoffice (manual)
  • clerk/clerk (manual)
  • clerk/clerk-docs (manual)
  • clerk/cloudflare-workers (manual)
  • clerk/clerk-ios (auto-detected)
  • clerk/clerk-android (auto-detected)
  • clerk/cli (auto-detected)

📝 Walkthrough

Walkthrough

The password-hashing support link in UserApi now uses the root-relative /contact/support path. A patch changeset documents this update for @clerk/backend.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the root-relative link change for the passwordHasher support reference.
Description check ✅ Passed The description directly explains the link change, its documentation impact, and the testing performed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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

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.

3 participants