Skip to content

Conversation

@SarahSoutoul
Copy link
Contributor

@SarahSoutoul SarahSoutoul commented Oct 15, 2025

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
    • Updated documentation link mappings to use billing payment method instead of billing payment source.
    • Added link mappings for billing statement totals, billing payment resource, and deleted object resource.
    • Removed the outdated billing payment source link mapping.
    • No changes to public APIs; these updates only affect documentation link resolution.

@changeset-bot
Copy link

changeset-bot bot commented Oct 15, 2025

⚠️ No Changeset found

Latest commit: 78c111e

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

@SarahSoutoul SarahSoutoul self-assigned this Oct 15, 2025
@vercel
Copy link

vercel bot commented Oct 15, 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 Oct 15, 2025 4:40pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 15, 2025

Walkthrough

Updated the LINK_REPLACEMENTS mapping in .typedoc/custom-plugin.mjs: replaced billing-payment-source-resource with billing-payment-method-resource, added mappings for billing-statement-totals, billing-payment-resource, and deleted-object-resource, and removed billing-payment-source-resource. No public/exported APIs changed.

Changes

Cohort / File(s) Summary
Doc plugin link map updates
.typedoc/custom-plugin.mjs
Updated LINK_REPLACEMENTS: replaced billing-payment-source-resource with billing-payment-method-resource; added billing-statement-totals, billing-payment-resource, deleted-object-resource; removed billing-payment-source-resource. No exported API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my whiskers, links align,
Hop-hop through docs, replacements fine.
Old sources fade, new methods gleam,
Statements tally in a tidy stream.
With gentle paws, I prune and add—
The map now hums; this bunny’s glad. 🐇✨

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 accurately reflects the main change of adding link replacements for broken types in the repository documentation and follows a conventional commit style. It is concise, specific, and clearly conveys the purpose of the pull request without unnecessary detail.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ss/fix-types-javascript

📜 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 1236c74 and 78c111e.

📒 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). (26)
  • GitHub Check: Integration Tests (billing, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 14)
  • GitHub Check: Integration Tests (expo-web, chrome)
  • GitHub Check: Integration Tests (nuxt, chrome)
  • GitHub Check: Integration Tests (nextjs, chrome, 15)
  • GitHub Check: Integration Tests (tanstack-react-start, chrome)
  • GitHub Check: Integration Tests (vue, chrome)
  • GitHub Check: Integration Tests (machine, chrome)
  • GitHub Check: Integration Tests (handshake, chrome)
  • GitHub Check: Integration Tests (express, chrome)
  • GitHub Check: Integration Tests (sessions:staging, chrome)
  • GitHub Check: Integration Tests (react-router, chrome)
  • GitHub Check: Integration Tests (handshake:staging, chrome)
  • GitHub Check: Integration Tests (localhost, chrome)
  • GitHub Check: Integration Tests (quickstart, chrome)
  • GitHub Check: Integration Tests (sessions, chrome)
  • GitHub Check: Integration Tests (ap-flows, chrome)
  • GitHub Check: Integration Tests (generic, chrome)
  • GitHub Check: Unit Tests (18, --filter=@clerk/astro --filter=@clerk/backend --filter=@clerk/express --filter=@c...
  • GitHub Check: Publish with pkg-pr-new
  • GitHub Check: Static analysis
  • GitHub Check: Unit Tests (22, **)
  • GitHub Check: Formatting | Dedupe | Changeset
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: semgrep-cloud-platform/scan
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
.typedoc/custom-plugin.mjs (1)

61-71: New billing link mappings look good.

Updated entries follow the existing pattern and will cover the renamed billing docs without affecting other replacements.


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.

@SarahSoutoul SarahSoutoul changed the title docs(repo): Add link replacements for broken types docs(repo): Add link replacements for broken types Oct 15, 2025
@pkg-pr-new
Copy link

pkg-pr-new bot commented Oct 15, 2025

Open in StackBlitz

@clerk/agent-toolkit

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

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

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

@clerk/elements

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

@clerk/clerk-expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/clerk-react

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

@clerk/react-router

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

@clerk/remix

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/themes

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

@clerk/types

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

@clerk/upgrade

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

@clerk/vue

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

commit: 78c111e

@SarahSoutoul SarahSoutoul merged commit c619d0d into main Oct 15, 2025
70 of 74 checks passed
@SarahSoutoul SarahSoutoul deleted the ss/fix-types-javascript branch October 15, 2025 16:56
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