Skip to content

docs: clarify core runtime public surface - #345

Merged
smiggleworth merged 1 commit into
mainfrom
docs/public-api-accuracy
Aug 24, 2026
Merged

docs: clarify core runtime public surface#345
smiggleworth merged 1 commit into
mainfrom
docs/public-api-accuracy

Conversation

@smiggleworth

Copy link
Copy Markdown
Contributor

Closes #335

Summary

  • replace actor-backed framing with the actual single-threaded lane-scheduled model
  • define /data as canonical while documenting root query exports as compatibility conveniences
  • show and explain both equivalent state() forms in the README and state/data guides
  • align the package description and root source header with the documented model

Verification

  • fresh build and all 37 repository checks passed
  • formatting, lint, and typecheck passed
  • local broad jsdom execution ran 1,443 tests green before host clock jumps prevented nine workers from starting; hosted CI is the complete merge gate

The package version remains 0.2.2. No lockfile, release artifact, tag, or publication was changed or created.

@smiggleworth
smiggleworth marked this pull request as ready for review August 24, 2026 05:39
@smiggleworth
smiggleworth force-pushed the docs/public-api-accuracy branch from 9ce2234 to 0b7a669 Compare August 24, 2026 05:39
Copilot AI lite review requested due to automatic review settings August 24, 2026 05:39

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@smiggleworth
smiggleworth merged commit 6aa3500 into main Aug 24, 2026
3 checks passed
@smiggleworth
smiggleworth deleted the docs/public-api-accuracy branch August 24, 2026 05:46
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.

Public API surface: documentation accuracy (actor-backed framing, root/data export split, state() dual API)

2 participants