Skip to content

Conversation

@LekoArts
Copy link
Contributor

@LekoArts LekoArts commented Jun 5, 2025

🔎 Previews:

Changed pages:

New pages:

What does this solve?

This adds Typedoc content to the "Types" pages of our JS Backend SDK. I've left out the "Auth" object for now because that is quite a bit more involved to get it in a presentable shape.

With this automation more docs pages will be kept in sync with the source code 🎉

What changed?

  • Some of the old pages linked to ClerkJS types although the source code references the Backend variants of those types (same name). For these types I added net-new pages for these backend types and link to them instead.
  • I've changed the slug of SamlConnection from saml-connection to backend-saml-connection to align it with the rest. A redirect was added for it.
  • Typedoc usage for backend types :)

Checklist

  • I have clicked on "Files changed" and performed a thorough self-review
  • All existing checks pass

@github-actions
Copy link
Contributor

github-actions bot commented Jun 5, 2025

Hey, here’s your docs preview: https://clerk.com/docs/pr/2292

@LekoArts LekoArts changed the title initial feat: Use Typedoc for Backend Types Jun 5, 2025
@LekoArts LekoArts marked this pull request as ready for review June 5, 2025 09:13
@LekoArts LekoArts requested a review from a team as a code owner June 5, 2025 09:13
@NWylynko
Copy link
Contributor

NWylynko commented Jun 9, 2025

On this page https://clerk.com/docs/pr/2292/references/backend/types/backend-organization-membership the OrganizationInvitationPublicMetadata and OrganizationInvitationPrivateMetadata are not linked

Screenshot 2025-06-09 at 11 08 33 PM

Created a pr clerk/javascript#6090

@NWylynko
Copy link
Contributor

NWylynko commented Jun 9, 2025

for https://clerk.com/docs/pr/2292/references/backend/types/backend-user

  • The property fullName isn't listed
image
  • The property primaryEmailAddress, primaryPhoneNumber and primaryWeb3Wallet isn't listed
Screenshot 2025-06-09 at 11 44 39 PM

Created a pr clerk/javascript#6091

@NWylynko NWylynko merged commit b8bfd2e into main Jun 9, 2025
9 checks passed
@NWylynko NWylynko deleted the lekoarts/eco-622-part-1 branch June 9, 2025 18:33
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