Skip to content

docs(repo): Fix broken link for create domain method typedoc output#8957

Merged
wobsoriano merged 2 commits into
mainfrom
ss/fix-broken-link-create-domain-method
Jun 22, 2026
Merged

docs(repo): Fix broken link for create domain method typedoc output#8957
wobsoriano merged 2 commits into
mainfrom
ss/fix-broken-link-create-domain-method

Conversation

@SarahSoutoul

@SarahSoutoul SarahSoutoul commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Description

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:

Summary by CodeRabbit

  • Documentation
    • Improved documentation page rendering by adjusting which page headings are removed during final processing.
    • Updated documentation link handling so references to create-organization-domain-params resolve correctly to the appropriate in-page anchor for smoother navigation.

@SarahSoutoul SarahSoutoul self-assigned this Jun 22, 2026
@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 11:02pm
swingset Ready Ready Preview, Comment Jun 22, 2026 11:02pm

Request Review

@changeset-bot

changeset-bot Bot commented Jun 22, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 553f9ba

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

This PR includes changesets to release 0 packages

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

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 Jun 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The TypeDoc custom plugin is updated to register create-organization-domain-params in two places: its MDX page is added to the heading-removal list, and a link-replacement mapping is added to rewrite references to that page as an anchor link. A changelog entry documents these updates.

Changes

TypeDoc MDX post-processing for create-organization-domain-params

Layer / File(s) Summary
Heading removal, link rewriting, and changelog
.typedoc/custom-plugin.mjs, .changeset/sweet-glasses-show.md
Adds create-organization-domain-params.mdx to FILES_WITHOUT_HEADINGS and adds a create-organization-domain-params#create-organization-domain-params entry to LINK_REPLACEMENTS. Changelog entry documents the plugin configuration update.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 Two tiny lines, a pair of hops,
A heading stripped, a link that swaps.
The docs plugin gains a brand-new page,
create-organization-domain takes the stage.
Small change, big cheer — the rabbit claps! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.
Title check ✅ Passed The title clearly and specifically summarizes the main change: fixing a broken link in documentation for the create domain method's TypeDoc output.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@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@8957

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 553f9ba

@SarahSoutoul SarahSoutoul changed the title docs(repo): Fix broken link for create domain method typedoc output docs(repo): Fix broken link for create domain method typedoc output Jun 22, 2026
@SarahSoutoul SarahSoutoul requested a review from wobsoriano June 22, 2026 23:12
@wobsoriano wobsoriano merged commit 52d310c into main Jun 22, 2026
48 of 50 checks passed
@wobsoriano wobsoriano deleted the ss/fix-broken-link-create-domain-method branch June 22, 2026 23:12
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