-
Notifications
You must be signed in to change notification settings - Fork 788
feat: Add Typedoc partials for React hooks & <ClerkProvider>
#2124
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Hey, here’s your docs preview: https://clerk.com/docs/pr/2124 |
TODO: Add instructions/explanations around this to the CONTRIBUTING section in this repo |
see some typedocs update suggestions I have: clerk/javascript#5457 |
Co-authored-by: Lennart <lekoarts@gmail.com>
Ready for another round of review! 🎉 |
Co-authored-by: Lennart <lekoarts@gmail.com>
There was a problem hiding this 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 🫶
There was a problem hiding this 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 !!! 🚢
Co-authored-by: Nick Wylynko <nickwylynko@clerk.dev> Co-authored-by: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com>
Co-authored-by: Nick Wylynko <nickwylynko@clerk.dev> Co-authored-by: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com>
🔎 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