-
Notifications
You must be signed in to change notification settings - Fork 935
Refresh customization docs #2823
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
Refresh customization docs #2823
Conversation
…t of customization
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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:
Thanks for contributing! 🙏 |
|
Okay, I have left an initial docs review with mostly writing style / syntax consistency. There are some bigger restructuring changes I want to do, but I wanted to first suggest them here and get everyone's opinions as they're important discussion pts @brkalow @alexisintech @manovotny:
|
|
@alexisintech @manovotny @brkalow point 4 has now been tackled in this commit. In addition to revamping the overview, I have also added a reference to the Theme editor in the Themes page. I also descoped that overview to be visible for all SDKs since it now refers to things that are available in all SDKs. But, I made sure to have a callout for native apps (for now iOS with Let me know if this new overview flows nicely. It's worth noting that the build fails for now, as the "old" account portal links are mentioned in some of the Typedocs. But this is where the Typedoc PR linked in this PR's description comes in. |
Co-authored-by: Michael Novotny <[email protected]>
Co-authored-by: Michael Novotny <[email protected]>
Co-authored-by: Michael Novotny <[email protected]>
Co-authored-by: Michael Novotny <[email protected]>
|
needs typedoc changes pulled in, but the most recent typedoc pr didn't pull in the merged typedoc changes |
Someone seems to have removed the linked Typedoc PR I had in the PR description. It is this one yeah: #2870. It did pull them in. If you check the Example:
|
awesome! i reviewed yesterday and it seems like its ready to ship 🚢 |



✅ Typedoc PR: clerk/javascript#7384
🔎 Previews:
What does this solve?
What changed?
Customizing Clerkoverview plus a dedicated Bring Your Own CSS guide, which moves existing content from the appearance prop overview page to a more use case focused guideappearanceprop reference to point toward the new guides and trim redundant explanationsaccount-portal/overviewto its own guide folder and updated the docs manifest and redirects to match the new structureChecklist