Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update BootTidal.hs and use Haskell syntax highlighting #252

Merged
merged 3 commits into from
Oct 31, 2023

Conversation

ijc8
Copy link
Contributor

@ijc8 ijc8 commented Oct 18, 2023

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:

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
Copy link
Collaborator

cleary commented Oct 24, 2023

Great idea
#257

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

Thanks :)

@cleary cleary merged commit c76d3e9 into tidalcycles:main Oct 31, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants