Skip to content

Restructure validation script #2203

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 131 commits into
base: main
Choose a base branch
from
Open

Restructure validation script #2203

wants to merge 131 commits into from

Conversation

NWylynko
Copy link
Contributor

@NWylynko NWylynko commented Apr 25, 2025 •
edited
Loading

No functionality change, just restructured out the validation / build script to be easier to manager & reason about.

Checklist

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

NWylynko added 30 commits February 7, 2025 23:01
@NWylynko
Modify sign in component docs to show how SDKFilter should be used
2d26b76
@NWylynko
Expand filter to display framework section for all frameworks with a …
a390825 
…<SignIn /> component regardless of if they have an example
@NWylynko
Filter Clerk Components to only frontend and full stack javascript ba…
2f91e1f 
…sed sdks
@NWylynko
Update the example to use the <If /> component
4c5c280
@NWylynko
Add the javascript sdk to the sdk filter in the manifest
720d0f7
@NWylynko
step 1 of the build script, generating a sdk specific manifest
2d5a2c6
@NWylynko
wip
2b21ce8
@NWylynko
use the vfile reporter
91b40db
@NWylynko
Check for markdown files that can be found in /docs/ but not manifest…
95a886b 
….json
@NWylynko
Better error message for failure to read in markdown file references …
c0165a4 
…from manifest
@NWylynko
Validate the manifest with zod
1188436
@NWylynko
Start work on compiling in partials
d1ffa88
@NWylynko
embed partials in to the markdown files we are generating
03351f6
@NWylynko
Merge branch 'main' into nick/docs-build-step
83a22c7
@NWylynko
catch partials inside partials
4fab404
@NWylynko
Filter out content for different sdks
9d7841a
@NWylynko
split up linting from generation to ensure full linting file coverage
739613f
@NWylynko
refactor for efficiency 25s down to 8s
f7d1ef5
@NWylynko
Merge branch 'main' into nick/docs-build-step
20b93ae
@NWylynko
Better error message for links with 404 hrefs
e8455ea
@NWylynko
accept jsx arrays of sdk prop
dd8f6b8
@NWylynko
Optimise build script by reducing times we parse the markdown
cde5c64
@NWylynko
undo changes that where for testing
a4b0241
@NWylynko
Better error message for not resolvable markdown file
5b34f30
@NWylynko
strip out .mdx extension from links to ensure they work as expected i…
2a586d5 
…n the website
@NWylynko
Setup the groundwork for a new <SDKLink /> component and <SDKDocRedir…
02865cc 
…ectPage /> component
@NWylynko
update validation comment
eeab48b
@NWylynko
Don't generate out docs that are not for the specific target sdk
02fa985
@NWylynko
Remove default values from manifests to cut down json file size
02b0ad8
@NWylynko
Merge branch 'main' into nick/docs-build-step
b11f7e5
NWylynko added 24 commits April 10, 2025 17:23
@NWylynko
Add config to clean the dist folder, and set it to true in --dev mode
ca134b9
@NWylynko
Send info up to parent process when --controlled
2049b18
@NWylynko
Swap out links in partials if they point to an sdk scoped page
51fbd15
@NWylynko
explicitly catch code wrapped links
786ec57
@NWylynko
Fix the icons partials to be processed correctly
eadae1d
@NWylynko
Check if we should ignore the link
e4fba71
@NWylynko
double pass the manifest for complete sdk filtering
2e70858
@NWylynko
Merge branch 'main' into nick/docs-build-step
3673942
@NWylynko
temp disable mdx parsing of typedoc, embed typedoc content in to the …
0f17c4e 
…output
@NWylynko
cache and invalidate typedoc markdown on file changes
6c3912a
@NWylynko
fallback to parsing the typedoc markdown without parsing out the mdx …
2b58dcf 
…if it errors
@NWylynko
remove typedoc fake submodule
3aa51c2
@NWylynko
Merge branch 'main' into nick/docs-build-step
8a08315
@NWylynko
Extract out some re-used code in to functions
158b28b
@NWylynko
wip break down monolithic build script
622f6b6
@NWylynko
Merge branch 'main' into nick/docs-build-step
413865e
@NWylynko
split out the functionality in to modules
05dd875
@NWylynko
Add comments for each file to explain its purpose
006c480
@NWylynko
clean up caching functionality
5e7170d
@NWylynko
clean up script messages
74ba3c7
@NWylynko
refactor out more of the remark plugins to be separate
961b20e
@NWylynko
rename validators to plugins to better reflect there purpose
7561b71
@NWylynko
pull out frontmatter extraction to its own plugin
0a8ae54
@NWylynko
Remove all generation aspects of the script
6a1cf8d
@github-actions GitHub Actions
Copy link

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

@github-actions GitHub Actions
Copy link

⚠️ Changes found in the following quickstarts:

  • overview.mdx

⚠️ Please update the corresponding quickstarts in the Dashboard

@NWylynko NWylynko marked this pull request as ready for review April 25, 2025 21:34
@NWylynko NWylynko requested a review from a team as a code owner April 25, 2025 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@NWylynko @jescalan