Adding tutorials/example projects to official docs

27 views
Skip to first unread message

Bobbie Chen

unread,
May 16, 2021, 2:28:33 PM5/16/21
to emscripte...@googlegroups.com
Hi all,

Would it be possible to add more tutorials or example projects to the official docs? What would be the process to do that?

I recently had the experience of trying to use WebAssembly with create-react-app. I didn't find anything in the official docs, which led me down various rabbit-holes of following random third-party tutorial blog posts that didn't work. Eventually I figured out something that worked for me and wrote it up at https://github.com/bobbiec/react-wasm-demo . But this took a lot of time and was frustrating.

I also realized afterwards, that all the pieces I needed were technically in the reference docs, just scattered across different places in a way that I never found them. Currently there is one tutorial page https://emscripten.org/docs/getting_started/Tutorial.html , which demonstrates how to use it in a Node or HTML output environment. I think it would be helpful to new users to outline some more use cases through tutorials on the official docs.

Thanks! (Also if there's a better place for this question let me know, I'm pretty new to this)

Bobbie

Sam Clegg

unread,
May 17, 2021, 1:07:16 PM5/17/21
to emscripte...@googlegroups.com
This is a good place to ask such questions.

I think we would welcome more tutorials on how to do certain things with emscripten.   The docs site is all stored in git at https://github.com/emscripten-core/emscripten/tree/main/site/source/docs/.   Most likely the reason there is nothing about react there is that none of the core contributors are familiar with react so we don't have the expertise needed to write or review such a tutorial.   If you would like to contribute one I think it would be most welcome, and perhaps there is someone else on this list who is familiar with react who could review it(?).  We would probably also want to add an end-to-end test to ensure that the techniques documented there do not regress.

cheers,
sam



Bobbie

--
You received this message because you are subscribed to the Google Groups "emscripten-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to emscripten-disc...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/emscripten-discuss/CAPmUznEsgyhEfxtraZ1pyM0SEibbQffeMq4eDBWsb4y11Csn%2BQ%40mail.gmail.com.

Sam Clegg

unread,
May 17, 2021, 2:37:46 PM5/17/21
to emscripte...@googlegroups.com
For reference, here is an example of a current PR that improves the docs on how to use emscripten in a specific way : https://github.com/emscripten-core/emscripten/pull/14058
Reply all
Reply to author
Forward
0 new messages