[Docs] Revisiting WASM integration in nucypher-ts #256
Labels
developer experience
Those issues that can make it difficult for a developer to use nucypher-ts
documentation
Improvements or additions to documentation
From an adopter with no previous experience perspective, I think the WASM configuration can be tricky.
Reading the Get started - Install nucypher-ts section, we can extract that:
First, we can read "One dependency takes advantage of WASM". Does this mean it is totally necessary to handle WASM? or is there a chance that I finally use some nucypher-ts component that doesn't need to use WASM? If it's mandatory to integrate WASM, I would say something like "nucypher-ts takes advantage of WASM", treating the package as a whole.
Also, we find three links here:
Fetch
,WebAssembly.intantiate
,XMLHttpRequest
and so on. AFAIK, a developer importing nucypher-ts doesn't need to do this, so this information can be confusing and unnecessary.As a suggestion, maybe we need a new section for WASM configuration. Do you think this would make easy the understanding of WASM implications?
These are my impressions when trying to put myself in nucypher-newbie shoes. But these can be partial or I may be missing information, so we can discuss this here.
The text was updated successfully, but these errors were encountered: