docs(backend): Use root-relative link for passwordHasher contact support reference - #9347
docs(backend): Use root-relative link for passwordHasher contact support reference#9347manovotny wants to merge 1 commit into
Conversation
…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>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 1b77872 The changes in this PR will be included in the next version bump. This PR includes changesets to release 10 packages
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 |
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/electron
@clerk/electron-passkeys
@clerk/eslint-plugin
@clerk/expo
@clerk/expo-google-signin
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/hono
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/react
@clerk/react-router
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/ui
@clerk/upgrade
@clerk/vue
commit: |
API Changes Report
Summary
No API Changes DetectedAll packages have stable APIs with no detected changes. Report generated by Break Check Last ran on |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
📝 WalkthroughWalkthroughThe password-hashing support link in Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
Description
The
passwordHasherparam JSDoc inpackages/backend/src/api/endpoints/UserApi.tsused an absolutehttps://clerk.com/contact/supportlink. The docs renderer (MDXLink.tsx) treats absolutehttp(s)://links as external — opening a new tab with an external-link icon — whereas root-relative links are internal same-tab.The Typedoc
replace-textplugin only relativizeshttps://clerk.com/docslinks, so this was the one non-/docsclerk.com link in the backend source and it leaked through as external. Switching it to/contact/supportmatches the convention already used for the/docs/...links authored directly in this same file.UserPasswordHashingParamsis shared by bothCreateUserParamsandUpdateUserParams, 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 absoluteclerk.com/contactlink.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change