Document building website with `npm run start` command about zing HOT 6 CLOSED

Thanks for the report @NickVolynkin.

For development changes and working on docs cd website && npm run start is prefered and works fine. That fires up a development server and changes are immediately effective in the browser.

Building via make docs hasn't been used for local development, but as a means to build the site for deployment and checking docs don't break during CI builds.

The fact that making a build and opening the contents locally doesn't display static files as it does on the web is because of the difference in base URL (note '/zing/' there). Also building creates files with some GitHub pages-specific considerations, like clean URLs, which will never work in local builds.

We could add a make docs-dev target if it makes things more discoverable. Please let us know if that would help or if you have other suggestions.

from zing.

@julen thanks, I just used npm run start and it works. I think it's best to just write about this command in readme or some other place in docs.

from zing.

I can take this task, maybe next week. @julen what do you say?

from zing.

Thanks for your willingness to help @NickVolynkin.

We can add a separate README.md in the website directory — let's keep it simple, concise and straight to the point.

Also note how short forms of commands like npm start works the same way as npm run start. You can read more about them on npm docs.

from zing.

This was taken care of in 80e8837.

from zing.

@julen thank you!

from zing.