tidalcycles.github.io icon indicating copy to clipboard operation
tidalcycles.github.io copied to clipboard

The missing chapter, for non-programmers

Open lennart opened this issue 10 years ago • 13 comments

Installation gets everyone up and running, Creating Patterns explains how to create patterns itself and the tidal DSL. The Reference is a function reference which show examples of a certain param or function in action.

However, for most people without a programming background, this does not help to make real use of all the functions, as the concepts on how to combine them, and the concepts that lie underneath (Haskell, functional programming) are not known for them.

We need a new chapter that will explain the concepts behind patterns, params and functions without all the techie talk I guess.

Suggestions for names and a rough outline would be great, before we dive in and add it to the docs.

lennart avatar Oct 26 '15 18:10 lennart

Is the tutorial any use as a starting point for this? https://github.com/tidalcycles/Tidal/blob/master/tutorial/tutorial.md

yaxu avatar Oct 28 '15 15:10 yaxu

I think that tutorial doc is really good. Curious to know what other Tidal beginners think of it. I'll try and round up some feedback.

On Wed, Oct 28, 2015 at 10:29 AM, Alex McLean [email protected] wrote:

Is the tutorial any use as a starting point for this? https://github.com/tidalcycles/Tidal/blob/master/tutorial/tutorial.md

— Reply to this email directly or view it on GitHub https://github.com/tidalcycles/tidalcycles.github.io/issues/22#issuecomment-151881875 .

kindohm avatar Oct 30 '15 12:10 kindohm

Ah, I didn't realise there was a tutorial. I'd love to see this incorporated into the site. Shall I make a pull request doing this?

lpil avatar Nov 24 '15 09:11 lpil

That'd be good! thanks

On 24 November 2015 at 09:03, Louis Pilfold [email protected] wrote:

Ah, I didn't realise there was a tutorial. I'd love to see this incorporated into the site. Shall I make a pull request doing this?

— Reply to this email directly or view it on GitHub https://github.com/tidalcycles/tidalcycles.github.io/issues/22#issuecomment-159200919 .

http://yaxu.org/

yaxu avatar Nov 24 '15 10:11 yaxu

I just had a go at this, but I can't work out the system for adding sections to a page. What conventions do I need to follow for this to work? I'm clearly missing something here.

lpil avatar Nov 24 '15 20:11 lpil

ok, this sounds like I should document the documentation which is clearly not self-explanatory (this is wonky…). Sorry!

Mainly, you have to edit _data/chapters.yml. I am currently updating the README to explain this concept, as this is not obvious.

lennart avatar Nov 24 '15 21:11 lennart

@lpil this is rough, but should be helping: https://github.com/lennart/tidalcycles.github.io/tree/docdoc

lennart avatar Nov 24 '15 21:11 lennart

Hm, I thought I was doing that, more or less. I'll try again tomorrow.

Thanks. :)

lpil avatar Nov 24 '15 22:11 lpil

Can you share your code, if you've forked the repo?

lennart avatar Nov 24 '15 22:11 lennart

I kept tweaking things and made a bit of a mess, so I wiped the branch. I'll share tomorrow if I'm still stumped. Cheers.

lpil avatar Nov 24 '15 22:11 lpil

@lpil are you going to be doing this? If not just shout! might be nice to have it ready for 0.9.

lennart avatar Dec 14 '16 19:12 lennart

Ah, I forgot about this. Realistically I don't have time, sorry. Would be great to have this though :)

lpil avatar Dec 14 '16 20:12 lpil

What concepts are missing that we'd like added? I can draft something for this as I add 0.9 function documentation.

sfradkin avatar Dec 14 '16 21:12 sfradkin