Generate object reference docs

[alexisintech]

⚠️ In conjunction with clerk/javascript#8276
To test:

• pull docs(shared): Add typedoc comments; remove functions from generated property tables for /objects javascript#8276
• 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

What does this solve? What changed?

It's time to get our /objects reference docs generated using typedoc!

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
clerk-docs	Error		Apr 17, 2026 11:06pm

[SarahSoutoul]

Okay, have pushed a minor docs review - clerk-options after reviewing the Typedoc output of the shared/clerk-options. Only does two things:

• Adds a missing sentence which is present on the current docs.
• Fixes the weird layout caused by wrapping.

Will continue reviewing and push a second docs review with the rest.

[SarahSoutoul]

@alexisintech Here is a second docs review pt 2 to just add the Typedoc outputs for the intros of each object.

Noticed they were there, looked good, but weren't being used. Again, if you don't love it, feel free to revert. This is in conjunction with the docs review in javascript repo which documents the intro of the Clerk object better.

[alexisintech]

@alexisintech Here is a second docs review pt 2 to just add the Typedoc outputs for the intros of each object.

Noticed they were there, looked good, but weren't being used. Again, if you don't love it, feel free to revert. This is in conjunction with the docs review in javascript repo which documents the intro of the Clerk object better.

me personally, I liked having the intro text in the mdx but your way of using typedoc for the intro text is fine too. I prefer the first way because if we ever want to update copy, we don't have to rely on a clerk/javascript PR (its fine for generated reference content because that's the point of it! but in the name of trying to minimize generating prose). however, either way we decide, I'm impartial ^~^

[SarahSoutoul]

me personally, I liked having the intro text in the mdx but your way of using typedoc for the intro text is fine too. I prefer the first way because if we ever want to update copy, we don't have to rely on a clerk/javascript PR (its fine for generated reference content because that's the point of it! but in the name of trying to minimize generating prose). however, either way we decide, I'm impartial ^~^

@alexisintech Yeah that's very fair feedback. Reverted changes: Revert 2nd docs review.