Skip to content

Fix the Sone 2 documentation build - #8

Open
sopenlaz0 wants to merge 1 commit into
seanghay:mainfrom
sopenlaz0:codex/finish-sone-2-docs-migration
Open

Fix the Sone 2 documentation build#8
sopenlaz0 wants to merge 1 commit into
seanghay:mainfrom
sopenlaz0:codex/finish-sone-2-docs-migration

Conversation

@sopenlaz0

@sopenlaz0 sopenlaz0 commented Aug 7, 2026

Copy link
Copy Markdown

Summary

The documentation still referenced Sone 1.4 and the removed dist/node.d.mts declaration 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

  • Documentation install, API generation, type-checking, and production build passed
  • Autoreview completed with no actionable findings

@vercel

vercel Bot commented Aug 7, 2026

Copy link
Copy Markdown

@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
sopenlaz0 marked this pull request as ready for review August 7, 2026 04:46

@sopenlaz0 sopenlaz0 left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review notes:

  • .github/workflows/tests.yaml: keep pull_request.types including synchronize—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:102 now 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.mdx correctly stop asserting here. Since core.ts JSDoc is already being edited, this is worth the one-line fix.

Nits (non-blocking):

  • npm ci --prefix docs alone doesn't install Sone's runtime dependencies (skia, yoga-layout, etc.). Because file:.. symlinks the root package, it relies on root node_modules and dist already existing. CI and the existing vercel-build script 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 rerunning npm 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.

@seanghay

seanghay commented Aug 7, 2026

Copy link
Copy Markdown
Owner

please make the changes small. and please dont modify the workflows

@sopenlaz0

Copy link
Copy Markdown
Author

Understood — I’ll revert the workflow changes and keep the PR focused. Thanks.

@sopenlaz0
sopenlaz0 force-pushed the codex/finish-sone-2-docs-migration branch from 7f769ab to 41cd129 Compare August 7, 2026 17:12
@sopenlaz0 sopenlaz0 changed the title [codex] Finish Sone 2 WASM docs migration Fix the Sone 2 documentation build Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants