This PR updates BootTidal.hs to include the various changes made upstream since it was added to the docs in #4 (back in May 2021).
I wonder if there's a good way to make BootTidal.hs the source of truth for the version embedded in the docs. It's already linked on the page, but the embedded snippet gets out-of-sync with the file it's referencing.
Client-side (runtime) options:
Use JS and fetch().
Use an <iframe>.
Both options ensure that BootTidal will appear up-to-date, but complicate syntax highlighting and make the docs less self-contained.
Server-side (build time) options:
Do something custom to fetch BootTidal.hs at build time and inject it into boottidal.md.
Or perhaps these are all overkill and the occasional PR works well enough.
(For context, I noticed that this page was stale because I wanted unmuteAll, went to write unmuteAll, and then belatedly realized that unmuteAllalready existed, but I didn't have it because my BootTidal.hs was based on the version in the docs.)
Alternatively, the embedded version could just be removed, such that readers click the link and get the current version.
Bonus question: should this page link to the BootTidal.hs in the Pulsar package or the latest release of Tidal? These are currently identical, but it seems like the former (which is what the docs link to now) is a copy of the latter, in which case maybe it's better to link to the original source.
This PR updates
BootTidal.hs
to include the various changes made upstream since it was added to the docs in #4 (back in May 2021).I wonder if there's a good way to make BootTidal.hs the source of truth for the version embedded in the docs. It's already linked on the page, but the embedded snippet gets out-of-sync with the file it's referencing.
Client-side (runtime) options:
fetch()
.<iframe>
.Both options ensure that BootTidal will appear up-to-date, but complicate syntax highlighting and make the docs less self-contained.
Server-side (build time) options:
BootTidal.hs
at build time and inject it intoboottidal.md
.Or perhaps these are all overkill and the occasional PR works well enough. (For context, I noticed that this page was stale because I wanted
unmuteAll
, went to writeunmuteAll
, and then belatedly realized thatunmuteAll
already existed, but I didn't have it because myBootTidal.hs
was based on the version in the docs.) Alternatively, the embedded version could just be removed, such that readers click the link and get the current version.Bonus question: should this page link to the
BootTidal.hs
in the Pulsar package or the latest release of Tidal? These are currently identical, but it seems like the former (which is what the docs link to now) is a copy of the latter, in which case maybe it's better to link to the original source.