o1-labs / docs2

Docs website for the Mina Protocol.
https://docs.minaprotocol.com
93 stars 136 forks source link

Update Web Worker UI Docs #1046

Closed ymekuria closed 1 month ago

ymekuria commented 1 month ago

Summary

This PR adds documentation on how to integrate web workers in a UI with o1js to 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 with o1js is 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 to o1js.

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 3, 2024 9:51pm
1 Skipped Deployment | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **07-oracles** | ⬜️ Ignored ([Inspect](https://vercel.com/minadocs/07-oracles/CpSryh23c3xh3rgxsPEXXSmypLGD)) | [Visit Preview](https://07-oracles-git-feature-update-webworker-docs-minadocs.vercel.app) | | Oct 3, 2024 9:51pm |