Skip to content

docs(repo): Fixing initial broken links - #9393

Draft
SarahSoutoul wants to merge 7 commits into
mainfrom
ss/fix-typedoc-broken-links
Draft

docs(repo): Fixing initial broken links#9393
SarahSoutoul wants to merge 7 commits into
mainfrom
ss/fix-typedoc-broken-links

Conversation

@SarahSoutoul

@SarahSoutoul SarahSoutoul commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes broken and incomplete TypeDoc links for several billing types.

This PR:

  • Adds canonical Clerk Docs link replacements for:
    • BillingAppliedDiscount
    • BillingCredits
    • BillingDiscountRedemption
    • BillingDiscounts
    • BillingPaymentTotals
    • BillingPayerCredit
    • BillingPeriodTotals
    • BillingProrationCreditDetail
    • BillingProrationDiscount
    • BillingSubscriptionItemNextPayment
    • BillingSubscriptionNextPayment
  • Adds complete JSDoc comments for:
    • BillingCredits
    • BillingPayerCredit
    • BillingProrationCreditDetail
    • BillingAppliedDiscount
    • BillingDiscountRedemption
  • Documents the BillingCredits properties on BillingCheckoutTotals and BillingSubscriptionItemResource, which were previously omitted from the generated output.
  • Marks ProtectAssertion and ProtectAssertionResolver as inline types so TypeDoc does not generate broken standalone links.

A fresh TypeDoc generation now produces standalone fragments with complete property tables for all five previously missing billing types:

  • billing-credits.mdx
  • billing-payer-credit.mdx
  • billing-proration-credit-detail.mdx
  • billing-applied-discount.mdx
  • billing-discount-redemption.mdx

clerk/clerk#3135 fixes the billing links whose TypeDoc fragments are already synced with Clerk Docs.

The five newly generated fragments above are intentionally not included in that Clerk PR. Once this JavaScript PR is released and the updated TypeDoc output is synced into Clerk Docs, their dedicated reference pages can be added in a follow-up Clerk PR.

To verify the changes, run pnpm test:typedoc and confirm the generated files and canonical /docs/reference/types/... links. The TypeDoc suite passes with 20 tests.

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:

@SarahSoutoul SarahSoutoul self-assigned this Aug 11, 2026
@vercel

vercel Bot commented Aug 11, 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 Aug 11, 2026 4:20pm
swingset Ready Ready Preview Aug 11, 2026 4:20pm

Request Review

@pkg-pr-new

pkg-pr-new Bot commented Aug 11, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 8427eda

@changeset-bot

changeset-bot Bot commented Aug 11, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 8427eda

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

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.

1 participant