docs(repo): Fixing initial broken links - #9393
Draft
SarahSoutoul wants to merge 5 commits into
Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@clerk/astro
@clerk/backend
@clerk/chrome-extension
@clerk/clerk-js
@clerk/electron
@clerk/electron-passkeys
@clerk/eslint-plugin
@clerk/expo
@clerk/expo-google-signin
@clerk/expo-passkeys
@clerk/express
@clerk/fastify
@clerk/hono
@clerk/localizations
@clerk/nextjs
@clerk/nuxt
@clerk/react
@clerk/react-router
@clerk/shared
@clerk/tanstack-react-start
@clerk/testing
@clerk/ui
@clerk/upgrade
@clerk/vue
commit: |
🦋 Changeset detectedLatest commit: 49c96a9 The changes in this PR will be included in the next version bump. This PR includes changesets to release 0 packagesWhen 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes broken and incomplete TypeDoc links for several billing types.
This PR:
BillingAppliedDiscountBillingCreditsBillingDiscountRedemptionBillingDiscountsBillingPaymentTotalsBillingPayerCreditBillingPeriodTotalsBillingProrationCreditDetailBillingProrationDiscountBillingSubscriptionItemNextPaymentBillingSubscriptionNextPaymentBillingCreditsBillingPayerCreditBillingProrationCreditDetailBillingAppliedDiscountBillingDiscountRedemptionBillingCreditsproperties onBillingCheckoutTotalsandBillingSubscriptionItemResource, which were previously omitted from the generated output.ProtectAssertionandProtectAssertionResolveras 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.mdxbilling-payer-credit.mdxbilling-proration-credit-detail.mdxbilling-applied-discount.mdxbilling-discount-redemption.mdxclerk/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:typedocand confirm the generated files and canonical/docs/reference/types/...links. The TypeDoc suite passes with 20 tests.Checklist
pnpm testruns as expected.pnpm buildruns as expected.Type of change