Skip to content

Conversation

LekoArts
Copy link
Contributor

@LekoArts LekoArts commented Mar 21, 2025

🔎 Previews:

What does this solve?

This PR is the final piece of wiring up the first Typedoc generated files into the docs. https://github.com/clerk/javascript has Typedoc support for a while now and right now I'm manually pushing its output to https://github.com/clerk/generated-typedoc. With changes to clerk.com the docs are now able to use the <Typedoc /> component to consume the files listed there.

I'll wire up automations to automatically update the generated-typedoc repo later (and also ensure that the paths stay the same).

Fixes ECO-430
Fixes ECO-524

What changed?

I think the changes are best reviewed by looking at each page side-by-side with the current one and take notes/screenshots of things that need changing.

It is expected that some tables are sorted differently or that some descriptions are more detailed.

Checklist

  • I have clicked on "Files changed" and performed a thorough self-review
  • I have added the "deploy-preview" label and added the preview link(s) to this PR description
  • All existing checks pass

Copy link
Contributor

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

@LekoArts
Copy link
Contributor Author

TODO: Add instructions/explanations around this to the CONTRIBUTING section in this repo

@LekoArts LekoArts marked this pull request as ready for review March 25, 2025 14:36
@LekoArts LekoArts requested a review from a team as a code owner March 25, 2025 14:36
@alexisintech
Copy link
Member

see some typedocs update suggestions I have: clerk/javascript#5457

@LekoArts LekoArts requested a review from alexisintech April 11, 2025 10:44
@LekoArts
Copy link
Contributor Author

Ready for another round of review! 🎉

@alexisintech
Copy link
Member

@LekoArts
Copy link
Contributor Author

LekoArts commented Apr 14, 2025

The parameters work fine for me (e.g. on canary version). Are you on an outdated version?

CleanShot 2025-04-14 at 19 14 31

The () can't be added to the functions since Typedoc can't infer that undefined is still a function. So it has to be like that for those tabs.

@alexisintech
Copy link
Member

The parameters work fine for me (e.g. on canary version). Are you on an outdated version?

CleanShot 2025-04-14 at 19 14 31

The () can't be added to the functions since Typedoc can't infer that undefined is still a function. So it has to be like that for those tabs.

oh, its on a canary version - well then that makes sense lol

Copy link
Member

@alexisintech alexisintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've left the last few comments ! Then this should be allll good to go.
I've created this pr with some updates: clerk/javascript#5643
so feel free to use that to resolve any of these comments, so we don't have to make multiple PR's 🫶

Copy link
Member

@alexisintech alexisintech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we ship !!! 🚢

@LekoArts LekoArts merged commit d7f3a6a into main Apr 22, 2025
7 checks passed
@LekoArts LekoArts deleted the typedoc/react-hooks branch April 22, 2025 09:06
alexisintech added a commit that referenced this pull request Apr 23, 2025
Co-authored-by: Nick Wylynko <nickwylynko@clerk.dev>
Co-authored-by: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com>
alexisintech added a commit that referenced this pull request May 27, 2025
Co-authored-by: Nick Wylynko <nickwylynko@clerk.dev>
Co-authored-by: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants