Code

Advanced docs validation script#2075

Code

Open

NWylynko wants to merge 77 commits intomainclerk/clerk-docs:mainfrom nick/advanced-docs-validation-scriptclerk/clerk-docs:nick/advanced-docs-validation-scriptCopy head branch name to clipboard

Commits

Commits on Feb 7, 2025

• Modify sign in component docs to show how SDKFilter should be used

  NWylynko

  committed
  2d26b76

  Copy full SHA for 2d26b76

• Expand filter to display framework section for all frameworks with a <SignIn /> component regardless of if they have an example

  NWylynko

  committed
  a390825

  Copy full SHA for a390825

• Filter Clerk Components to only frontend and full stack javascript based sdks

  NWylynko

  committed
  2f91e1f

  Copy full SHA for 2f91e1f

Commits on Feb 10, 2025

• Update the example to use the <If /> component

  NWylynko

  committed
  4c5c280

  Copy full SHA for 4c5c280

• Add the javascript sdk to the sdk filter in the manifest

  NWylynko

  committed
  720d0f7

  Copy full SHA for 720d0f7

Commits on Feb 14, 2025

• step 1 of the build script, generating a sdk specific manifest

  NWylynko

  committed
  2d5a2c6

  Copy full SHA for 2d5a2c6

Commits on Feb 17, 2025

• wip

  NWylynko

  committed
  2b21ce8

  Copy full SHA for 2b21ce8

Commits on Feb 18, 2025

• use the vfile reporter

  NWylynko

  committed
  91b40db

  Copy full SHA for 91b40db

• Check for markdown files that can be found in /docs/ but not manifest.json

  NWylynko

  committed
  95a886b

  Copy full SHA for 95a886b

• Better error message for failure to read in markdown file references from manifest

  NWylynko

  committed
  c0165a4

  Copy full SHA for c0165a4

• Validate the manifest with zod

  NWylynko

  committed
  1188436

  Copy full SHA for 1188436

• Start work on compiling in partials

  NWylynko

  committed
  d1ffa88

  Copy full SHA for d1ffa88

Commits on Feb 19, 2025

• embed partials in to the markdown files we are generating

  NWylynko

  committed
  03351f6

  Copy full SHA for 03351f6

• Merge branch 'main' into nick/docs-build-step

  NWylynko

  committed
  83a22c7

  Copy full SHA for 83a22c7

• catch partials inside partials

  NWylynko

  committed
  4fab404

  Copy full SHA for 4fab404

Commits on Feb 20, 2025

• Filter out content for different sdks

  NWylynko

  committed
  9d7841a

  Copy full SHA for 9d7841a

• split up linting from generation to ensure full linting file coverage

  NWylynko

  committed
  739613f

  Copy full SHA for 739613f

• refactor for efficiency 25s down to 8s

  NWylynko

  committed
  f7d1ef5

  Copy full SHA for f7d1ef5

• Merge branch 'main' into nick/docs-build-step

  NWylynko

  committed
  20b93ae

  Copy full SHA for 20b93ae

• Better error message for links with 404 hrefs

  NWylynko

  committed
  e8455ea

  Copy full SHA for e8455ea

• accept jsx arrays of sdk prop

  NWylynko

  committed
  dd8f6b8

  Copy full SHA for dd8f6b8

Commits on Feb 24, 2025

• Optimise build script by reducing times we parse the markdown

  NWylynko

  committed
  cde5c64

  Copy full SHA for cde5c64

• undo changes that where for testing

  NWylynko

  committed
  a4b0241

  Copy full SHA for a4b0241

• Better error message for not resolvable markdown file

  NWylynko

  committed
  5b34f30

  Copy full SHA for 5b34f30

• strip out .mdx extension from links to ensure they work as expected in the website

  NWylynko

  committed
  2a586d5

  Copy full SHA for 2a586d5

• Setup the groundwork for a new <SDKLink /> component and <SDKDocRedirectPage /> component

  NWylynko

  committed
  02865cc

  Copy full SHA for 02865cc

• update validation comment

  NWylynko

  committed
  eeab48b

  Copy full SHA for eeab48b

• Don't generate out docs that are not for the specific target sdk

  NWylynko

  committed
  02fa985

  Copy full SHA for 02fa985

• Remove default values from manifests to cut down json file size

  NWylynko

  committed
  02b0ad8

  Copy full SHA for 02b0ad8

• Merge branch 'main' into nick/docs-build-step

  NWylynko

  committed
  b11f7e5

  Copy full SHA for b11f7e5

• For <SDKLink />, scope to :sdk: for the component to then swap out for the users active SDK

  NWylynko

  committed
  fbca9c7

  Copy full SHA for fbca9c7

Commits on Feb 25, 2025

• Add comment

  NWylynko

  committed
  f36ae58

  Copy full SHA for f36ae58

• Create a dev mode for the dev script

  NWylynko

  committed
  66e99d9

  Copy full SHA for 66e99d9

Commits on Feb 26, 2025

• (wip) improve the validation to ensure <If /> can't filter to sdk that not available based on manifest

  NWylynko

  committed
  1a60e95

  Copy full SHA for 1a60e95

• Merge branch 'main' into nick/docs-build-step

  NWylynko

  committed
  224d3a0

  Copy full SHA for 224d3a0

Commits on Feb 27, 2025

• Fix up the types

  NWylynko

  committed
  9e708b0

  Copy full SHA for 9e708b0

• Setup testing for the build script

  NWylynko

  committed
  e7ec2b4

  Copy full SHA for e7ec2b4

• fix test

  NWylynko

  committed
  316cdd9

  Copy full SHA for 316cdd9

• Write a second test

  NWylynko

  committed
  8964d90

  Copy full SHA for 8964d90

• more tests

  NWylynko

  committed
  611da4b

  Copy full SHA for 611da4b

• more tests

  NWylynko

  committed
  cb3f17d

  Copy full SHA for cb3f17d

• More tests :)

  NWylynko

  committed
  7163efd

  Copy full SHA for 7163efd

Commits on Feb 28, 2025

• Merge branch 'main' into nick/docs-build-step

  NWylynko

  committed
  268ccb9

  Copy full SHA for 268ccb9

• tests :D

  NWylynko

  committed
  451e260

  Copy full SHA for 451e260

Commits on Mar 4, 2025

• finish off the tests

  NWylynko

  committed
  f8bff1e

  Copy full SHA for f8bff1e

Commits on Mar 5, 2025

• Cut down the build script to just do validation

  NWylynko

  committed
  002239c

  Copy full SHA for 002239c

• fix up types

  NWylynko

  committed
  66c68e5

  Copy full SHA for 66c68e5

• run prettier

  NWylynko

  committed
  3deaae7

  Copy full SHA for 3deaae7

• Merge branch 'main' into nick/advanced-docs-validation-script

  NWylynko

  committed
  ce70dbd

  Copy full SHA for ce70dbd

• run prettier again

  NWylynko

  committed
  24cd69d

  Copy full SHA for 24cd69d

• clean up the pr a little

  NWylynko

  committed
  81332d6

  Copy full SHA for 81332d6

Commits on Mar 6, 2025

• Fail the run on warnings

  NWylynko

  committed
  322c333

  Copy full SHA for 322c333

• review comments

  jescalan

  committed
  0727b64

  Copy full SHA for 0727b64

• Implement improvements from code review

  NWylynko

  committed
  0eb81d6

  Copy full SHA for 0eb81d6

• test build script

  NWylynko

  committed
  d1ca7fc

  Copy full SHA for d1ca7fc

• run formatter

  NWylynko

  committed
  5d6d298

  Copy full SHA for 5d6d298

• Merge branch 'main' into nick/advanced-docs-validation-script

  NWylynko

  committed
  118d686

  Copy full SHA for 118d686

• switch all terminology from guide over to doc

  NWylynko

  committed
  39673a2

  Copy full SHA for 39673a2

Commits on Mar 7, 2025

• fix sdk manifest filtering

  NWylynko

  committed
  488776e

  Copy full SHA for 488776e

• <If /> component will no always have sdk prop

  NWylynko

  committed
  e49329f

  Copy full SHA for e49329f

• use __dirname and update to support base dir being ./scripts/

  NWylynko

  committed
  cca0784

  Copy full SHA for cca0784

Commits on Mar 10, 2025

• add pull request trigger

  NWylynko

  committed
  1c1010e

  Copy full SHA for 1c1010e

• ✨ prettier ✨

  NWylynko

  committed
  8bfa306

  Copy full SHA for 8bfa306

• update github action paths

  NWylynko

  committed
  ac002e7

  Copy full SHA for ac002e7

• Only need to do it on pushes

  NWylynko

  committed
  50bb6d5

  Copy full SHA for 50bb6d5

• remove dev mode

  NWylynko

  committed
  a77115a

  Copy full SHA for a77115a

• omit an warning on a missing description

  NWylynko

  committed
  c8a75d2

  Copy full SHA for c8a75d2

• More robust id pull for markdown file headings

  NWylynko

  committed
  b1e9dd4

  Copy full SHA for b1e9dd4

• fix heading id pull

  NWylynko

  committed
  5b8e085

  Copy full SHA for 5b8e085

• Fix up the quick link in the terminal to files

  NWylynko

  committed
  55f67f4

  Copy full SHA for 55f67f4

• add the build script (in its current validation state) as a lint step

  NWylynko

  committed
  e11d4e4

  Copy full SHA for e11d4e4

• ✨ prettier ✨

  NWylynko

  committed
  4bcaf97

  Copy full SHA for 4bcaf97

• Merge branch 'main' into nick/advanced-docs-validation-script

  NWylynko

  committed
  56bb206

  Copy full SHA for 56bb206

• Validate contents of partials

  NWylynko

  committed
  fbb46ec

  Copy full SHA for fbb46ec

• separate out the partials validation to give better warning messages

  NWylynko

  committed
  18ecb6b

  Copy full SHA for 18ecb6b

• remove unused dep

  NWylynko

  committed
  c764355

  Copy full SHA for c764355

• ✨ prettier ✨

  NWylynko

  committed
  e7a1425

  Copy full SHA for e7a1425