Skip to content

docs(backend,shared): Generate typedoc output for backend docs#8853

Draft
alexisintech wants to merge 1 commit into
mainfrom
aa/DOCS-10984
Draft

docs(backend,shared): Generate typedoc output for backend docs#8853
alexisintech wants to merge 1 commit into
mainfrom
aa/DOCS-10984

Conversation

@alexisintech

@alexisintech alexisintech commented Jun 13, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds JSDoc comments to resources in packages/backend/src/api/endpoints/**/*.
  • Adds a custom @expandProperties modifier tag (handled by .typedoc/custom-plugin.mjs) so generic-instantiation aliases like UserListParams = ClerkPaginationRequest<{...}> render as a single merged properties table instead of an empty page. typedoc-plugin-markdown otherwise has no rendering branch for top-level ReferenceTypes. Tag applied to ClerkPaginationRequest and ClerkPaginationParams.

Test plan

  • pnpm typedoc:generate completes without errors
  • cd .typedoc && npx vitest run passes

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@changeset-bot

changeset-bot Bot commented Jun 13, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 5147b18

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

@vercel

vercel Bot commented Jun 13, 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 13, 2026 12:36am
swingset Ready Ready Preview, Comment Jun 13, 2026 12:36am

Request Review

@coderabbitai

coderabbitai Bot commented Jun 13, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository YAML (base), Repository UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 4238445b-c707-470f-bbdd-a5352a0f3735

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

@pkg-pr-new

pkg-pr-new Bot commented Jun 13, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: 5147b18

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant