Mithril.js: [docs] Simple Application forgets the step where you create src/index.js

[trosel]

The tutorial asks you to create index.html at the very start, but it doesn't have you create index.js.

This is confusing because on line 195 of the tutorial, it says that you already created index.js.

https://github.com/MithrilJS/mithril.js/edit/next/docs/simple-application.md#l195

[trosel]

In addition, if index.js is the correct reference here, it's not clear how they expect the student to render this file in their browser.

[orbitbot]

@WildYorkies this is probably an easy PR if you're so inclined 😄

[trosel]

@orbitbot I thought so too, but the more I thought about it, the more confused I became.

Because as I mentioned, it's _also_ not clear how they expect the student to render the file in the browser. It didn't work for me to try to render app.js for example.

[orbitbot]

Since we're talking about a compilation tool (webpack), the default configuration (I believe) will after it has been run create a file at the relative path bin/app.js as we can see in https://github.com/MithrilJS/mithril.js/edit/next/docs/simple-application.md#l18 . It may be that an up to date webpack has changed this to something else, I'm unfortunately not familiar with the state of the art.

I'm not 💯 what you mean by "render", assuming the bin/app.js file has been created through the webpack build step, it should be enough to open the index.html file in your browser and the app should automatically load after all the javascript has been parsed.

[trosel]

Yes, I tried to open that index.html file (because I thought that the author confused it for index.js) but it didn't work.

Otherwise I would gladly do a PR. I just don't know enough about mithril to answer myself.

[7h3m4dS0u1]

@WildYorkies the index.js file was created during the installation process. https://mithril.js.org/installation.html

See this paragraph in https://mithril.js.org/simple-application.html

"To install Mithril, follow the instructions in the installation page. Once you have a project skeleton with Mithril installed, we are ready to create the application."

[orbitbot]

@WildYorkies if you're still having issues, you could try asking on the Gitter chat https://gitter.im/mithriljs/mithril.js - might be easier and quicker to solve there

[trosel]

@7h3m4dS0u1 The issue is that the simple application tutorial guides the reader in building a project form scratch.

It has you create an index.html file and then do an npm init in that directory later.

If the tutorial wants to rely on the seven steps outlined here then it should not guide you as if you should create your own index.html file.

[trosel]

https://github.com/MithrilJS/mithril.js/pull/2184