Hacker News new | ask | show | jobs
by Twirrim 1187 days ago
Almost every language has a simple walk through that goes step by step and explains what parts are, or gets you to the point of having your first working application.

Here you go "here's how to set up your build platform".. and good luck?

The content under that github repo doesn't explain anything. It's just a dump of code. Why are the various parts there, how does this interact with TeaVM, how does this interact with the web page and why?

The documents are written assuming knowledge, and the code does nothing to actually explain what is going on, how things should be laid out or anything. There's no readme, and no comments other than the license blurb.

How does someone with no familiarity with TeaVM at all, know how to even get started?

I appreciate writing documentation sucks, but if you want your project to take off, it's not enough for it to be good on a technical level. You need to be hand holding through the entire initial process. One of the things that is consistent right throughout technology is that the best solution isn't the one that gets chosen. It's the one that has the lowest barrier of entry, and the best user experience.

One of the things that catapulted Ruby from being some obscure language to immense popularity was the first Ruby on Rails tutorials that had you making a functional blog site, taking you from first line of code to functional site pretty quickly. Ruby wasn't that special or unique as a language, but suddenly this framework came along on it that was transformative (compared to the general state of the market) that made it easy to build a website and then start modifying it.

By way of contrast for your documentation, searching for rust webassembly takes me to https://www.rust-lang.org/what/wasm which has a link to an introductory documentation https://rustwasm.github.io/docs/book/introduction.html Then in the "Hello World" section, https://rustwasm.github.io/docs/book/game-of-life/hello-worl..., it explains what each file is, why, what's happening in them, and ultimately leads to you having a working example website.

To take another example, I just googled python and webassembly, which to me to pyodide's website. The first section of their site after the introduction to what pyodide is, https://pyodide.org/en/stable/usage/quickstart.html walks you through how pyodide works in the browser, how to get your code in and functional and gets to to a place where you've created a functional page.

Ruby's stuff around webassembly is pretty fresh and documentation doesn't seem to be linked from their website, but from a quick online search https://ruby.github.io/ruby.wasm/ appears to be there. Same story as with pyodide, albeit the documentation for ruby wasm is really bare right now, but it still gives you a quick example, explains how to put your code in to the site, or as WASI, and gets you up and running.

If you want TeaVM to take off, you have to make it easy for people to get started. Absurdly so. Walk them step by step to having a functional website leveraging it. Explain what's going on at each stage, and why various lines of code are needed. What they're doing. Build up their understanding that you already have.