Update Web Worker UI Docs #1046
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…reflect app router
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
…allation instructions
…code snippets for clear viewing
…orker client section
Trivo25
reviewed
Oct 2, 2024
45930
approved these changes
Oct 2, 2024
…o preparing the project section
…ader defining worker funtions section header
…running in the web worker
…ning in the web worker
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds documentation on how to integrate web workers in a UI with
o1jsto coincide with the improvements in the reference implementation that were introduced with this PR. The documentation provides an example of how to use the comlink package introduced in the reference implementation to simplify the communication with web workers.Closes #1047
Impact
Currently web workers are necessary to build performant and usable UIs with
o1js. Integrating and managing web workers witho1jsis complex, and hard to manage according to many developers on discord. These developers have requested that we simplify the process. This step by step example documentation coupled with the improved web worker reference implementation improves the DX.Changes
Future Plans
The long term goal is to eliminate the need for web workers with updates to
o1js. In the short term we are aiming to improve the DX of building UIs with changes like this one. The example implementation and documentation will be incrementally improved until we reach the longer term goal with improvements too1js.