Fix the Sone 2 documentation build - #8
Conversation
|
@sopenlaz0 is attempting to deploy a commit to the Seanghay Yath's projects Team on Vercel. A member of the Team first needs to authorize it. |
sopenlaz0
left a comment
There was a problem hiding this comment.
Review notes:
-
.github/workflows/tests.yaml: keeppull_request.typesincludingsynchronize—that event is what gives fork PRs CI on updates. Scope the other trigger instead:push: branches: [main]
This avoids redundant branch-push runs while retaining CI coverage when fork PRs update.
-
src/index.ts:102now contradicts the docs this PR ships. Low severity.CanvasKit has no system fonts, so at least one font must be registered before rendering any text.
That's the 1.x rule that the README and
fonts.mdxcorrectly stop asserting here. Sincecore.tsJSDoc is already being edited, this is worth the one-line fix.
Nits (non-blocking):
npm ci --prefix docsalone doesn't install Sone's runtime dependencies (skia,yoga-layout, etc.). Becausefile:..symlinks the root package, it relies on rootnode_modulesanddistalready existing. CI and the existingvercel-buildscript both perform the root install/build first, so this is correct as shipped; it is just an unstated ordering requirement for contributors. I specifically tested whether this creates release-blocking lockfile coupling by adding and bumping root dependencies, then rerunningnpm ci --prefix docs; it does not—npm doesn't validate the linked..snapshot.- Rewriting the dated 1.4 blog post's “What's next” section as “What changed in 2.0” is a little revisionist when the version banner already provides that context. Your call.
|
please make the changes small. and please dont modify the workflows |
|
Understood — I’ll revert the workflow changes and keep the PR focused. Thanks. |
7f769ab to
41cd129
Compare
Summary
The documentation still referenced Sone 1.4 and the removed
dist/node.d.mtsdeclaration after the Sone 2 migration.This updates the dependency and API generator, and fixes four incomplete entries that prevented type-checking. Lockfile and generated API changes are mechanical.
Validation