docs not updated automatically
keep jekyll? move hosting? what's up with dev.tidalcycles.org?
shall we postpone this until docs are ready, or would it aid progress?
Hosting is now on my server. dev.tidalcycles.org is the version on github, although I'm worried it will end up being indexed - it needs a warning on it somehow if it is going to become a development version of the docs. I think it would be good to have docs updating automatically.
I tried around with haskell-src-exts and hakyll to generate and integrate our source docs. See the current state of autogeneration you can also read/clone sourcecode for generation which is an adaption of the current jekyll based site (incomplete).
This is implemented using hakyll which could be used to generate the rest of the docs (possibly more)
Looking at the result, it might be good to first decide on how to proceed:
- drop all the facade modules like
PatternTransformersetc. and just "document" existing modules, no change in structure of the source code - restructure Tidal modules to adhere to our original reference docs sections.
- completely restructure tidal modules and the docs together (I'd vote for this one!)
In any case, I think we should get our source-docs as complete and good as possible and then see what we can do with it later on, currently it seems to lack structure we might need when generating websites from it and "changing" the structure of the sourcecode docs on the fly is not feasible I think.
sorry, in a hurry now, will continue with updating source docs in tidal-0.9-dev I guess...
will work on the above, elaborating ways to differentiate comment types in source-code (source only, haddock, website) now