Skip to content

docs(backend): use canonical Dashboard API key links - #9653

Open
SarahSoutoul wants to merge 2 commits into
mainfrom
ss/DOCS-12082
Open

docs(backend): use canonical Dashboard API key links#9653
SarahSoutoul wants to merge 2 commits into
mainfrom
ss/DOCS-12082

Conversation

@SarahSoutoul

@SarahSoutoul SarahSoutoul commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Description

This updates the backend JSDoc annotations that feed the backend and Next.js TypeDoc reference pages.

The shared publishableKey, secretKey, and jwtKey descriptions still linked to the legacy Dashboard URL https://dashboard.clerk.com/last-active?path=api-keys. They now use the canonical active-instance shortcut, https://dashboard.clerk.com/~/api-keys.

Those three source annotations expand to 12 links across the generated backend and Next.js reference pages. The companion docs PR syncs that output and prevents /last-active links from validating in the future: https://github.com/clerk/clerk/pull/3294

Testing performed:

  • Generated TypeDoc for the backend and Next.js packages
  • Verified the five affected generated pages contain the 12 canonical links
  • Ran Prettier over the three changed source files

Checklist

Type of change

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

Other resources

@vercel

vercel Bot commented Sep 3, 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 4, 2026 5:30pm UTC
swingset Ready Ready Preview Sep 4, 2026 5:30pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Sep 3, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 3e7824d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@coderabbitai

coderabbitai Bot commented Sep 3, 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: ASSERTIVE

Plan: Team

Run ID: 89e1e9d2-9593-4737-9e76-c6dc2adf608a

📥 Commits

Reviewing files that changed from the base of the PR and between 760da4c and 3e7824d.

📒 Files selected for processing (3)
  • packages/backend/src/tokens/keys.ts
  • packages/backend/src/tokens/types.ts
  • packages/backend/src/tokens/verify.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) → reviewed against open PR #3294 ss/DOCS-12082 instead of the default branch

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


📝 Walkthrough

Walkthrough

Updated the documentation links for secretKey, publishableKey, and jwtKey. All three links now target the current Clerk Dashboard API keys page.

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

Merge Risk: ⚪ Minimal · up to 3e782

This updates API-key documentation links for backend token options to the current Clerk Dashboard page without changing application behavior or public API contracts.

Suggested reviewers: dominic-clerk

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly explains the JSDoc link updates, affected keys, generated documentation impact, testing, and companion documentation changes.
Title check ✅ Passed The title clearly and concisely describes the main change: replacing backend documentation links with canonical Dashboard API key links.
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 3…
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 3, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 3e7824d

@SarahSoutoul SarahSoutoul changed the title Fix Dashboard API key links in TypeDoc sources feat(backend): Fix Dashboard API key links in TypeDoc sources Sep 3, 2026
@SarahSoutoul SarahSoutoul self-assigned this Sep 4, 2026
@SarahSoutoul SarahSoutoul changed the title feat(backend): Fix Dashboard API key links in TypeDoc sources docs(backend): use canonical Dashboard API key links Sep 4, 2026
@SarahSoutoul
SarahSoutoul marked this pull request as ready for review September 4, 2026 17:33
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-09-04T17:37:11.455Z

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 3e7824d.

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.

1 participant