Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Gitbook docs] Lack of information in Get Started about WASM bindings #119

Closed
manumonti opened this issue Nov 29, 2022 · 2 comments
Closed

Comments

@manumonti
Copy link
Member

While I was trying to build a new app, I found a lack of information in Get Started with TAC. This caused that I got stuck in the Step 2: Build a Cohort

IMHO, the use of WASM bindings should be documented here as a kind of "prerequisite" or "step 0". The problem I found trying to build a basic app is:

  1. nucypher-ts uses nucypher-core as a dependency. nucypher-core contains WASM bindings.
  2. To run nucypher-ts (and hence, WASM from nucypher-core) we need a bundler that understands what WASM is.
  3. Depending on what project we're running, two good options could be to use Webpack or Craco, but in any case, we need to tell them how to load WASM.

In any case, we have some examples of how to start building a new dApp here, here, and here, that could be linked in this documentation.

_Originally posted by @manumonti in #179

@manumonti manumonti mentioned this issue Nov 29, 2022
@manumonti manumonti changed the title Lack of information in Get Started about WASM bindings Lack of information in Get Started (gitbook) about WASM bindings Nov 29, 2022
@piotr-roslaniec
Copy link
Contributor

We also have a bunch of integration examples that show how to properly load nucypher-ts with its WASM dependencies.

@manumonti manumonti changed the title Lack of information in Get Started (gitbook) about WASM bindings [Gitbook docs] Lack of information in Get Started about WASM bindings Nov 29, 2022
@piotr-roslaniec
Copy link
Contributor

Addressed in this change set.

gitbook-com bot pushed a commit to threshold-network/threshold that referenced this issue Dec 7, 2022
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

No branches or pull requests

2 participants