Skip to content

Conversation

alexisintech
Copy link
Member

@alexisintech alexisintech commented Sep 30, 2025

Description

Currently, in the docs, clicking on a link to any of these pages will append .mdx to the path, and it will break the sidebar.

Screen.Recording.2025-09-30.at.15.51.17.mov

This PR adds link replacements for these paths so that Typedoc knows what exact path these links should point to

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 generated docs by expanding link rewriting rules, ensuring references to several billing-related resources and a specific feature/resource type resolve correctly.
    • Reduced broken or misdirected links in MDX content, leading to more reliable navigation across related pages.
    • No behavioral changes to the product; updates solely enhance documentation accuracy and link consistency.

Copy link

changeset-bot bot commented Sep 30, 2025

⚠️ No Changeset found

Latest commit: 5b48173

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

Copy link
Contributor

coderabbitai bot commented Sep 30, 2025

Walkthrough

Expanded the LINK_REPLACEMENTS table in the TypeDoc custom plugin by adding nine new MDX link replacement mappings for billing-related resources and a feature/resource type. No logic, control flow, or error handling changes.

Changes

Cohort / File(s) Summary
Docs link replacement mappings
\.typedoc/custom-plugin.mjs
Added nine new entries to LINK_REPLACEMENTS for MDX link rewriting, covering billing-related resource types and a feature/resource type; no functional logic modified.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I hop through docs, quick paws alight,
Mapping links from left to right—
Billing trails now neat and tight,
Threads unknotted, paths made bright.
Bunny stamps, approved tonight! 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title clearly and concisely describes the primary change—adding Typedoc link replacements for commerce types—aligning directly with the PR’s objective of extending the LINK_REPLACEMENTS for billing-related resources without extraneous detail.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch aa/add-commerce-link-replacements

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 3edc07c and 5b48173.

📒 Files selected for processing (1)
  • .typedoc/custom-plugin.mjs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: Build Packages
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: semgrep/ci
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
.typedoc/custom-plugin.mjs (1)

58-65: Great coverage of the missing billing doc slugs.

Thanks for filling out the remaining replacements so Typedoc resolves these commerce types without appending .mdx. This keeps the sidebar stable for the billing and feature resources.


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 and usage tips.

Copy link

vercel bot commented Sep 30, 2025

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

Project Deployment Preview Comments Updated (UTC)
clerk-js-sandbox Ready Ready Preview Comment Sep 30, 2025 7:52pm

Copy link

pkg-pr-new bot commented Sep 30, 2025

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@6894

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@6894

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@6894

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@6894

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@6894

@clerk/types

npm i https://pkg.pr.new/@clerk/types@6894

@clerk/upgrade

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

@clerk/vue

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

commit: 5b48173

@alexisintech alexisintech merged commit 2754a77 into main Sep 30, 2025
44 checks passed
@alexisintech alexisintech deleted the aa/add-commerce-link-replacements branch September 30, 2025 20:01
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.

2 participants