Skip to content

Better "Getting Started" Docs

Athan Clark requested to merge docs-getting-started-20210724 into master

There's a number of improvements to the prose in this MR:

  • Updated documentation to be more relevant to the current version of Shpadoinkle (i.e. we have live reload now, and most of the nix is under nix/base.nix rather than default.nix in snowman builds)
  • General prose improvements to help readability
  • More hand-holding to help people get more familiar to the build environment, and how to use the nix commands

I've also added live-reload support to the examples that didn't have it (except for the lazy-loading and widgets examples).

However, this MR also recognizes some buggy behavior when running Shpadoinkle as a server, at least on FireFox. This is due to JSaddle using synchronous XHR requests, as identified by https://github.com/ghcjs/jsaddle/issues/64. Discussion is underway, and a Shpadoinle issue is about to be made to document and tackle this problem.

Merge request reports