tidalcycles / tidal-doc

https://tidalcycles.org
GNU General Public License v3.0
19 stars 84 forks source link

Update `BootTidal.hs` and use Haskell syntax highlighting #252

Closed ijc8 closed 1 year ago

ijc8 commented 1 year ago

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:

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:

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 unmuteAll already 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.

cleary commented 1 year ago

Great idea https://github.com/tidalcycles/tidal-doc/issues/257

I've also answered the bonus question as a review item

Thanks :)