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

Split Book into Four Sections #85

Closed
3 tasks
mgattozzi opened this issue Mar 8, 2018 · 5 comments
Closed
3 tasks

Split Book into Four Sections #85

mgattozzi opened this issue Mar 8, 2018 · 5 comments

Comments

@mgattozzi
Copy link
Contributor

Today in the WG meeting we discussed who wasm and this book is for and we struck upon three groups:

  1. Those who want to use wasm in a JS library
  2. Those who want to use Rust only for a web app via wasm
  3. Those who want to use wasm as a cross platform binary and not just the web

Each group has different restrictions and wants. For instance those who would want to run a wasm executable file on a computer could care less about how to do JS interop. Those wishing to interact with JS would want to know however.

This creates a bit of a conflict when developing the documentation. They'll have to skip sections they might not want to read. Even worse if this is their first introduction to wasm and what they want to use it for they will likely be left confused.

This leads us to the current goal: splitting up the book. It'll be four sections:

  1. Things that span all three groups, such as setting up the tool chain, what wasm is etc.
  2. Library for JS - Tools, tutorials, information etc. specific to this domain
  3. Pure Rust Web App - Tools, tutorials, information etc. specific to this domain
  4. Universal Binary - Tools, tutorials, information etc. specific to this domain

Tasks for this include:

  • Restructure the book to have the 4 top level sections and an introduction explaining that
  • Breaking out what's currently there into the four sections
  • Provide some external resources for those sections not currently expanded much
@sendilkumarn
Copy link
Member

Lets start ✍️

@mgattozzi
Copy link
Contributor Author

@sendilkumarn yeah! I'm going to land #78 soonish so let's do this right after that! :D
The main work of breaking this up can definitely be started though. Do you want to take lead on this?

@sendilkumarn
Copy link
Member

👍

@mgattozzi
Copy link
Contributor Author

Sweet. I think you can probably still do most of this without that PR landing first, and then rebase once it does! :D If you run into any snags let me know

@jrichocean
Copy link

This issue has been moved here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants