Skip to content

docs(clerk-js): add link replacement for OAuth Application#8945

Merged
wobsoriano merged 4 commits into
mainfrom
jfoshee/oauth2-custom-consent-docs-oauth-app-link
Jun 22, 2026
Merged

docs(clerk-js): add link replacement for OAuth Application#8945
wobsoriano merged 4 commits into
mainfrom
jfoshee/oauth2-custom-consent-docs-oauth-app-link

Conversation

@jfoshee

@jfoshee jfoshee commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Currently the link to OAuthApplicationNamespace at https://clerk.com/docs/js-frontend/reference/objects/clerk#oauthapplication routes to a 404

In conjunction with the pending docs PR:
clerk/clerk-docs#3315
This will fix that link to point at the new page at reference/types/oauth-application

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: docs

Summary by CodeRabbit

  • Documentation
    • Improved documentation link routing for OAuth application namespace references, ensuring users are directed to the correct reference documentation page.

@changeset-bot

changeset-bot Bot commented Jun 22, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: dfad569

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

@vercel

vercel Bot commented Jun 22, 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, Comment Jun 22, 2026 6:54pm
swingset Ready Ready Preview, Comment Jun 22, 2026 6:54pm

Request Review

@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The head commit changed during the review from fc4e037 to ea9accc.

📝 Walkthrough

Walkthrough

A new entry is added to the LINK_REPLACEMENTS array in .typedoc/custom-plugin.mjs to rewrite o-auth-application-namespace links to /docs/reference/types/oauth-application during MDX post-processing. The corresponding test snapshot in .typedoc/__tests__/__snapshots__/clerk-properties.mdx is updated to reflect the new absolute link format.

Changes

OAuth Application Link Replacement

Layer / File(s) Summary
Add o-auth-application-namespace link replacement
.typedoc/custom-plugin.mjs, .typedoc/__tests__/__snapshots__/clerk-properties.mdx
Plugin adds a new tuple to LINK_REPLACEMENTS mapping o-auth-application-namespace to /docs/reference/types/oauth-application; snapshot is updated to reflect the new absolute link format in generated documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A rabbit hops through docs so fine,
One tuple added to the line,
OAuth links now find their way,
Through the plugin's rewrite array,
🐇 One small entry, saved the day!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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: adding a link replacement for OAuth Application documentation references in the TypeDoc configuration.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

@jfoshee jfoshee requested a review from SarahSoutoul June 22, 2026 16:28
@jfoshee jfoshee changed the title docs: add link replacement for OAuth Application docs(clerk-js): add link replacement for OAuth Application Jun 22, 2026
@pkg-pr-new

pkg-pr-new Bot commented Jun 22, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: dfad569

Currently the link to `OAuthApplicationNamespace` at https://clerk.com/docs/js-frontend/reference/objects/clerk#oauthapplication routes to a 404

In conjunction with the pending docs PR:
clerk/clerk-docs#3315
This will fix that link to point at the new page at `reference/types/oauth-application`
@wobsoriano wobsoriano merged commit dd51fe4 into main Jun 22, 2026
45 checks passed
@wobsoriano wobsoriano deleted the jfoshee/oauth2-custom-consent-docs-oauth-app-link branch June 22, 2026 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants