Generate backend docs

[alexisintech]

⚠️ clerk/javascript#8853 must be shipped first

To test:

• pull docs(backend,shared): Generate typedoc output for backend docs javascript#8853
• run pnpm run typedoc:generate:skip-build (as long as you have clerk-docs and clerk/javascript symlinked; see the clerk/clerk README.md)
• run the docs (in clerk/clerk, run pnpm run dev)
• preview the docs locally. I like to split screen with the current production docs on one side, and the local preview of these changes on the other side, and then manually compare to ensure all the information in the newly generated docs are accurate.

What does this solve? What changed?

Generates the Backend reference docs from Typedoc. Across every Backend API resource, hand-written ## Properties / ## Parameters / ## Returns tables and ## Example(s) sections were replaced with <Typedoc /> includes, and the sidebar was restructured to group methods by resource.

Sidebar restructure

• Sidebar entries alphabetized.
• Backend prefix removed from titles in the Types section.

New pages — Backend methods

• docs/reference/backend/api-keys/get-secret.mdx
• docs/reference/backend/domains/{add,delete,list,update}.mdx
• docs/reference/backend/enterprise-connections/{create,delete,get,get-list,update}-enterprise-connection.mdx
• docs/reference/backend/organization/create-organization-domain.mdx
• docs/reference/backend/organization/delete-organization-domain.mdx
• docs/reference/backend/organization/get-organization-domain-list.mdx
• docs/reference/backend/organization/update-organization-domain.mdx
• docs/reference/backend/organization/get-instance-organization-membership-list.mdx
• docs/reference/backend/organization/replace-organization-metadata.mdx
• docs/reference/backend/user/replace-user-metadata.mdx
• docs/reference/backend/user/set-password-compromised.mdx
• docs/reference/backend/user/unset-password-compromised.mdx

New pages — Backend types

• docs/reference/backend/types/backend-agent-task.mdx
• docs/reference/backend/types/backend-m2m-token.mdx
• docs/reference/backend/types/backend-machine.mdx
• docs/reference/backend/types/backend-machine-scope.mdx
• docs/reference/backend/types/backend-organization-domain.mdx
• docs/reference/backend/types/backend-sign-in-token.mdx
• docs/reference/backend/types/backend-testing-token.mdx
• docs/reference/backend/types/deleted-object.mdx
• docs/reference/backend/types/domain.mdx

Removed sections

• PublicOrganizationDataJSON properties section removed from docs/reference/backend/types/backend-organization-invitation.mdx.
• Hand-authored ## Properties tables removed from Backend type pages (e.g. billing-plan, billing-subscription, billing-subscription-item, feature) — now sourced from Typedoc.

Content updates

• ## Example(s) headings → ## Usage.
• "Retrieve" → "get" in method copy for consistency.
• Inline comment links back to the JS source files removed.
• Backend reference callout moved under the ## Usage heading.
• deleteDomain signature aligned with the JS source.

Other doc updates outside docs/reference/backend/

• docs/reference/objects/organization.mdx — added createOrganizationDomainParams section and attemptOwnershipVerification / prepareOwnershipVerification Typedoc method blocks.
• docs/reference/types/billing-plan-price.mdx — new BillingPlanPrice type page (linked from the manifest under Types).
• docs/guides/development/testing/overview.mdx — Testing Tokens copy now points at createTestingToken() in addition to the Backend API.
• docs/_partials/user-object.mdx — small clarification pointing metadata writes at updateUserMetadata().

Deadline

• No rush.

Other resources

• DOCS-10984

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
clerk-docs	Ready	Preview	Jun 30, 2026 11:44pm

[SarahSoutoul]

@alexisintech Left a small docs review - user addressing the following issue.

The examples for setPasswordCompromised() and unsetPasswordCompromised() use the wrong call shape. In their respective pages in the docs, the examples pass a single object like clerkClient.users.setPasswordCompromised({ userId, ... }). But the generated API signature is setPasswordCompromised(userId: string, params) and unsetPasswordCompromised(userId: string). Fixed the code examples to reflect the generated API signature.

[SarahSoutoul]

@alexisintech Retrieve -> get - keep consistency -> Made a small prose consistency pass across the backend get* reference pages to smooth out the new Typedoc-based docs. Mostly, replacing instances of Retrieves/retrieve with Gets/get to be consistent with the rest + standardized usage blurbs like "filtered by the number of results" to clearer phrasing such as "limited to the specified number of results" / "skipping the specified number of results".

I noticed one more thing consistency wise for the method pages that have a layout with Usage and then a Basic heading. Some have the backend usage partial after the Usage heading and some after the Basic heading. To me, it should be after Usage heading as it applies to all examples, but didn't want to do anything to see which way you'd want to go. Regardless, we should make it consistent:

[SarahSoutoul]

@alexisintech One thing I noticed is there is a bit of inconsistency with capitalization in the sidebar. For e.g., the following:

• Enterprise Connections
• M2M Tokens
• Waitlist Entries
• Agent Tasks
  ...and others have the second word capitalized but their pages don't follow that norm like Testing Tokens for e.g., where the page does follow that norm and therefore it makes sense. But then, things like OAuth applications, Email addresses, Phone numbers, etc. have the second word lowercase.

I think we either go with the consistency of having the second word capitalized for all or we capitalize the second word when that's the norm in the doc, what do you think?

Also should User, Organization, Client and Instance be -> Users, Organizations, Clients and Instances to align with the rest?

[alexisintech]

@alexisintech One thing I noticed is there is a bit of inconsistency with capitalization in the sidebar. For e.g., the following:

• Enterprise Connections
• M2M Tokens
• Waitlist Entries
• Agent Tasks
  ...and others have the second word capitalized but their pages don't follow that norm like Testing Tokens for e.g., where the page does follow that norm and therefore it makes sense. But then, things like OAuth applications, Email addresses, Phone numbers, etc. have the second word lowercase.

I think we either go with the consistency of having the second word capitalized for all or we capitalize the second word when that's the norm in the doc, what do you think?

Also should User, Organization, Client and Instance be -> Users, Organizations, Clients and Instances to align with the rest?

those are Clerk-specific terms, which always get capitalized in the docs
and yes I can update those to be plural to match their resource names!

[SarahSoutoul]

those are Clerk-specific terms, which always get capitalized in the docs and yes I can update those to be plural to match their resource names!

I don't know if I follow here sorry. If Enterprise Connections and Agent Tasks are Clerk-specific terms, they don't seem to be capitalized in the docs? And then I can see Waitlist Entries and M2M Tokens were changed so that's all good / makes sense. @alexisintech

[github-actions]

⚠️ TypeDoc files detected in this PR

This PR modifies files in the 'clerk-typedoc/' folder. These files are auto-generated from the clerk/javascript repository and should not be edited directly.

To make changes to TypeDoc documentation:

1. 🔄 Make your changes in the appropriate files in the clerk/javascript repository.
2. 🚀 The TypeDoc documentation will be pulled through to this repository via a CI action.

Thanks for contributing! 🙏