You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There are a few pieces in the Hello World chapter that are not as clear as they could be.
code snippets include optional dependency
Instructions on serving the wasm file are confusing.
1 - The file name referred to in the html/script is hello_world.gc.opt.wasm which is only the name of the file if you've chosen to 'make the binary even smaller'. Because this is an optional step, one may not take it, especially if they're just trying to experiment quickly or getting a working setup. A simple fix would be to not name the file differently during the optional step.
2 - There are two ways to serve the wasm file, one using the https crate (or a webserver one may have already installed on the machine) and another using the Python3 simple server. However the instructions in the Note say there is a stipulation on the webservers that may be used. The majority of users checking this out for the first time will likely be on a machine without a real webserver installed. The Python3 server is used fairly ubiquitously in example code throughout the web, so I think it might be a good idea to list this first.
It is confusing to include both example in a Hello World section. I think it might benefit users to only include one, either require the https crate to be used (which is a reasonable dependency) or only list the Python3 example with a note of the caveat and that there is a potentially better way to do it when the user gets to the real world.
The text was updated successfully, but these errors were encountered:
Oh yes, this tripped me up too, because I skipped the optional step! Although a good lesson in debugging and reading the things that I paste from the internet into my terminal, I agree that it is a bit unclear.
There are a few pieces in the
Hello World
chapter that are not as clear as they could be.wasm
file are confusing.1 - The file name referred to in the html/script is
hello_world.gc.opt.wasm
which is only the name of the file if you've chosen to 'make the binary even smaller'. Because this is an optional step, one may not take it, especially if they're just trying to experiment quickly or getting a working setup. A simple fix would be to not name the file differently during the optional step.2 - There are two ways to serve the
wasm
file, one using thehttps
crate (or a webserver one may have already installed on the machine) and another using the Python3 simple server. However the instructions in theNote
say there is a stipulation on the webservers that may be used. The majority of users checking this out for the first time will likely be on a machine without a real webserver installed. The Python3 server is used fairly ubiquitously in example code throughout the web, so I think it might be a good idea to list this first.It is confusing to include both example in a
Hello World
section. I think it might benefit users to only include one, either require thehttps
crate to be used (which is a reasonable dependency) or only list the Python3 example with a note of the caveat and that there is a potentially better way to do it when the user gets to the real world.The text was updated successfully, but these errors were encountered: