# Updating the Tidal website and documentation

**URL:** <https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654>\
**Category:** TidalCycles\
**Tags:** resources\
**Created:** [24 December 2020 16:18 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654 "2020-12-24T16:18:29Z")\
**Posts on this page:** 20\
**Page:** 3

<div class="post-metadata">

**Author:** ![munshkr](https://uzu.lurk.org/user_avatar/uzu.lurk.org/munshkr/32/138_2.png) [@munshkr](https://uzu.lurk.org/u/munshkr)\
**Post date:** [2 January 2021 13:35 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/42 "2021-01-02T13:35:53Z")

</div>

> [@yaxu](#):
>
> Work out how to get the mediawiki exports generating nicely and integrated with translations

I've been working on this a bit, but still needs a few things before importing everything. To name a few: Fix internal links, and maybe group all functions in a single md file?

> [@yaxu](#):
>
> However I can't work out how to make use of the 'insiders' stuff, in particular language selection. I subscribed for $10 but don't want to stay subscribed forever.. I tried just copying it into [https://github.com/tidalcycles/tidal-doc/tidal-doc-theme](https://github.com/tidalcycles/tidal-doc/tidal-doc-theme), and pointing to that in [https://github.com/tidalcycles/tidal-doc/blob/main/mkdocs.yml](https://github.com/tidalcycles/tidal-doc/blob/main/mkdocs.yml), but the language selector isn't appearing.. Hm!

Fixed. `custom_dir` should point to the `material/` directory inside `tidal-doc-theme/` as that contains the production build.

_edit_: I'm sure we can take the language selector (and some other insider feature we want) and make it an "override" of the open source theme.

---

<div class="post-metadata">

**Author:** ![yaxu](https://uzu.lurk.org/user_avatar/uzu.lurk.org/yaxu/32/2_2.png) [@yaxu](https://uzu.lurk.org/u/yaxu)\
**Post date:** [2 January 2021 13:56 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/43 "2021-01-02T13:56:16Z")

</div>

Ace thanks! With grouping all functions in a single file, I guess having separate files has some advantages, making it easier to build it into context sensitive help files for editors? But then it would still be best to have the reference on one page on the website somehow.

I agree it's best to build off the fully open public github repo to get future updates, taking the insider features we want. Strictly speaking the 'insider' stuff is open source (MIT licensed I think), so we're fine to do that.

---

<div class="post-metadata">

**Author:** ![yaxu](https://uzu.lurk.org/user_avatar/uzu.lurk.org/yaxu/32/2_2.png) [@yaxu](https://uzu.lurk.org/u/yaxu)\
**Post date:** [2 January 2021 16:14 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/44 "2021-01-02T16:14:54Z")

</div>

Hm I had a go at backporting the language selector on the open material release.. I managed to get the `<link rel>`'s in the html header, but the drop-down language selection is in `partials/header.html`, which isn't organised into blocks, and is auto-generated somehow with a message saying that it shouldn't be edited.. If I copy the whole file across then things break.

---

<div class="post-metadata">

**Author:** ![munshkr](https://uzu.lurk.org/user_avatar/uzu.lurk.org/munshkr/32/138_2.png) [@munshkr](https://uzu.lurk.org/u/munshkr)\
**Post date:** [2 January 2021 18:45 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/45 "2021-01-02T18:45:41Z")

</div>

> [@yaxu](#):
>
> Ace thanks! With grouping all functions in a single file, I guess having separate files has some advantages, making it easier to build it into context sensitive help files for editors? But then it would still be best to have the reference on one page on the website somehow

You're right, I think it's better to have them in separate pages, and then have an index for them, included in the nav as a section.

> [@yaxu](#):
>
> Hm I had a go at backporting the language selector on the open material release.. I managed to get the `<link rel>`'s in the html header, but the drop-down language selection is in `partials/header.html`, which isn't organised into blocks, and is auto-generated somehow with a message saying that it shouldn't be edited.. If I copy the whole file across then things break

I managed to make the `<select>` work somehow, but the styling is wrong (I must be missing some styles, or maybe it's using a different version of material components).

---

<div class="post-metadata">

**Author:** ![munshkr](https://uzu.lurk.org/user_avatar/uzu.lurk.org/munshkr/32/138_2.png) [@munshkr](https://uzu.lurk.org/u/munshkr)\
**Post date:** [5 January 2021 19:03 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/46 "2021-01-05T19:03:35Z")

</div>

> [@munshkr](#):
>
> I managed to make the `<select>` work somehow, but the styling is wrong (I must be missing some styles, or maybe it's using a different version of material components).

Ok, the language selector is working now. I also wrote some js to make the links go to the current's page language (if you are on `/funcs/rev`, and you hit the German link, it should go to `/de/funcs/rev` now, instead of `/de`).

Going to look into the wiki importer again now.

---

<div class="post-metadata">

**Author:** ![yaxu](https://uzu.lurk.org/user_avatar/uzu.lurk.org/yaxu/32/2_2.png) [@yaxu](https://uzu.lurk.org/u/yaxu)\
**Post date:** [5 January 2021 19:30 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/47 "2021-01-05T19:30:51Z")

</div>

Thanks looking good, I'm trying to focus on releasing tidal 1.6.2 this week so might go might go quiet for a bit!

---

<div class="post-metadata">

**Author:** ![C-o](https://uzu.lurk.org/user_avatar/uzu.lurk.org/c-o/32/1692_2.png) [@C-o](https://uzu.lurk.org/u/C-o)\
**Post date:** [2 February 2021 09:53 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/48 "2021-02-02T09:53:34Z")

</div>

Hi Alex!  
I think you mentioned making some changes to the userbase during the stream the other day? If not, please ignore this.  
If you're taking suggestions regarding what to add or whatever I'd love a wikipedia-style "random article"-link. In the context of Tidal maybe it would be "random function".

---

<div class="post-metadata">

**Author:** ![yaxu](https://uzu.lurk.org/user_avatar/uzu.lurk.org/yaxu/32/2_2.png) [@yaxu](https://uzu.lurk.org/u/yaxu)\
**Post date:** [2 February 2021 10:33 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/49 "2021-02-02T10:33:49Z")

</div>

Hi @C-o yes, I've moved your idea to the existing documentation update thread.

The documentation update has been on hold while releasing Tidal 1.7 but will return to it soon.

The current userbase uses the same software as wikipedia so you can go to a random page in the same way: [https://tidalcycles.org/Special:Random](https://tidalcycles.org/Special:Random)

---

<div class="post-metadata">

**Author:** ![yaxu](https://uzu.lurk.org/user_avatar/uzu.lurk.org/yaxu/32/2_2.png) [@yaxu](https://uzu.lurk.org/u/yaxu)\
**Post date:** [7 February 2021 23:34 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/50 "2021-02-07T23:34:43Z")

</div>

I'm just looking at this nice system for managing translations:  
[https://weblate.org/](https://weblate.org/)

It'd be nice to integrate this with the new site. However searching for 'weblate' and 'mkdocs' doesn't seem to turn up any advice for getting them together.. But maybe it wouldn't be too hard.

Otherwise without this sort of system I worry it'll be hard to keep the different translations in sync with one another.

---

<div class="post-metadata">

**Author:** ![dowdiness](https://uzu.lurk.org/user_avatar/uzu.lurk.org/dowdiness/32/1761_2.png) [@dowdiness](https://uzu.lurk.org/u/dowdiness)\
**Post date:** [1 March 2021 18:31 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/51 "2021-03-01T18:31:11Z")

</div>

Hello alex!

Maybe I'm little bit too late to comment about website builder, but is mkdocs suitable for new Tidal documentation website?

IMHO [Docusaurus](https://v2.docusaurus.io/) is the most easiest and flexible static site generator when it comes to documentation websites.

It has nice styled default template without complicated configurations, search functionality is easy to implemented and ready for internationalization.

In Docusaurus we can use [Crowdin](https://v2.docusaurus.io/docs/next/i18n/crowdin) for translation which is free for [open-source projects](https://crowdin.com/page/open-source-project-setup-request). (or just use [git](https://v2.docusaurus.io/docs/next/i18n/git))

I think using modern Jamstack framework make contributions easy as well. Many frontend engineers are familiar with react and node.js ecosystem. (including me)

I'd like to help making new website if you choose this tech stack.

> **[Introduction | Docusaurus](https://v2.docusaurus.io/docs/next/)**
>
> Docusaurus was designed from the ground up to be easily installed and used to get your website up and running quickly.

---

<div class="post-metadata">

**Author:** ![yaxu](https://uzu.lurk.org/user_avatar/uzu.lurk.org/yaxu/32/2_2.png) [@yaxu](https://uzu.lurk.org/u/yaxu)\
**Post date:** [1 March 2021 19:54 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/52 "2021-03-01T19:54:38Z")

</div>

Hi @dowdiness,

As you can see we started work on a mkdocs-based website but things stalled a bit. The lack of built-in translation is a bit of a blocker.. If docusaurus can solve that one that'd be great! I see it's based around markdown as well so wouldn't be a whole lot different to work with?

---

<div class="post-metadata">

**Author:** ![dowdiness](https://uzu.lurk.org/user_avatar/uzu.lurk.org/dowdiness/32/1761_2.png) [@dowdiness](https://uzu.lurk.org/u/dowdiness)\
**Post date:** [1 March 2021 20:22 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/53 "2021-03-01T20:22:08Z")

</div>

I made a PR for Docusaurus version documentation site. Yes, it's markdown based static site generator as well so switching to Docusaurus from MkDocs is not difficult at all.

> <https://github.com/tidalcycles/tidal-doc/pull/1>

---

<div class="post-metadata">

**Author:** ![yaxu](https://uzu.lurk.org/user_avatar/uzu.lurk.org/yaxu/32/2_2.png) [@yaxu](https://uzu.lurk.org/u/yaxu)\
**Post date:** [1 March 2021 21:13 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/54 "2021-03-01T21:13:45Z")

</div>

Thanks a lot!

github tells me that immer should be 8.0.1 or later, it's `1.10.0` in yarn.lock. What's the best way to ugprade that?

I'm not very familiar with modern web technologies..

---

<div class="post-metadata">

**Author:** ![dowdiness](https://uzu.lurk.org/user_avatar/uzu.lurk.org/dowdiness/32/1761_2.png) [@dowdiness](https://uzu.lurk.org/u/dowdiness)\
**Post date:** [1 March 2021 21:31 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/55 "2021-03-01T21:31:00Z")

</div>

I don't get that error when I run locally. I guess you mixed npm and yarn or node\_modules. Just delete node\_modules folder and package-lock.json(if you have).

Then run

```haskell
yarn install

```

and

```haskell
yarn start.

```

Docusaurus site will be running on [http://localhost:3000](http://localhost:3000).

If you don't have yarn yet, you can install yarn by

```haskell
npm install --global yarn

```

If you use homebrew, you can install yarn by

```haskell
brew install yarn.

```

as well.

---

<div class="post-metadata">

**Author:** ![dowdiness](https://uzu.lurk.org/user_avatar/uzu.lurk.org/dowdiness/32/1761_2.png) [@dowdiness](https://uzu.lurk.org/u/dowdiness)\
**Post date:** [1 March 2021 21:38 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/56 "2021-03-01T21:38:53Z")

</div>

Uh... this is not accurate. I think your yarn's version is 1.10.0 but actual latest version is 1.22.10. That's why you get that kind of warning.

Just execute

```haskell
npm update --global yarn

```

for updating yarn.

---

<div class="post-metadata">

**Author:** ![yaxu](https://uzu.lurk.org/user_avatar/uzu.lurk.org/yaxu/32/2_2.png) [@yaxu](https://uzu.lurk.org/u/yaxu)\
**Post date:** [1 March 2021 21:43 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/57 "2021-03-01T21:43:30Z")

</div>

Thanks that fixed it!

I didn't get the github action building it. Probably it is best to test locally and then do `yarn deploy` by hand anyway.

---

<div class="post-metadata">

**Author:** ![dowdiness](https://uzu.lurk.org/user_avatar/uzu.lurk.org/dowdiness/32/1761_2.png) [@dowdiness](https://uzu.lurk.org/u/dowdiness)\
**Post date:** [1 March 2021 21:55 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/58 "2021-03-01T21:55:28Z")

</div>

Do you know Vercel? I think this hosting service is faster than github pages leveraged by CDN. You can get preview site every PR so reviewing PR is much easier. They can sponsor open source project if you contact them.

> **[Can Vercel sponsor my open source project? - Vercel Support Article](https://vercel.com/support/articles/can-vercel-sponsor-my-open-source-project)**
>
> Information on how Vercel can sponsor your open source project and how to apply.

  

> **[Deployment | Docusaurus](https://v2.docusaurus.io/docs/next/deployment#deploying-to-vercel)**
>
> To build the static files of your website for production, run:

---

<div class="post-metadata">

**Author:** ![kit-christopher](https://uzu.lurk.org/user_avatar/uzu.lurk.org/kit-christopher/32/686_2.png) [@kit-christopher](https://uzu.lurk.org/u/kit-christopher)\
**Post date:** [17 March 2021 13:26 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/59 "2021-03-17T13:26:21Z")

</div>

@yaxu @geikha i've had a thought recently about systematically sifting through the rocketchat and the discord channels to pull out some useful questions/answers/examples that could potentially enrich the official tidal documentation. i feel like oftentimes there's a lot of really key information from the chatrooms that never get recorded and would be extremely useful to the larger community. i see there are a few (3rd party) ways to export messages from both clients but wanted to check with the respective admins first to see if either of you knew other ways this might be accomplished. let me know your thoughts.

---

<div class="post-metadata">

**Author:** ![cleary](https://uzu.lurk.org/user_avatar/uzu.lurk.org/cleary/32/177_2.png) [@cleary](https://uzu.lurk.org/u/cleary)\
**Post date:** [18 March 2021 04:30 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/60 "2021-03-18T04:30:17Z")

</div>

I had a chat with a colleague about this who does discord related bot development -

He demonstrated that there are bots that do on demand logging/archiving but I feel like maybe it would be more worthwhile just writing all channels direct to text based logs on the server directly (named by server-channel-daterange) ... these can then be shared somehow.

He's offered to write something that would do this, but without knowledge of any of the infrastructure running the discord, I have no idea if the idea is feasible - can anyone clarify if this would work?

---

<div class="post-metadata">

**Author:** ![slowleopard](https://uzu.lurk.org/user_avatar/uzu.lurk.org/slowleopard/32/1785_2.png) [@slowleopard](https://uzu.lurk.org/u/slowleopard)\
**Post date:** [25 March 2021 17:22 UTC](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654/61 "2021-03-25T17:22:14Z")

</div>

Hi! I am just joining this conversation now, and maybe missing some details, but from the last few posts I have read I gather that the documentation will eventually be moved from MediaWiki to something else. Is this right? I'm wondering because... although I'm new here... I have been adding some (afaik) undocumented functions to the wiki, and I guess I just want to find out if I should wait to do this on whatever new system is implemented.

[Previous page](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654.md?page=2)

[Next page](https://uzu.lurk.org/t/updating-the-tidal-website-and-documentation/2654.md?page=4)
