strudel icon indicating copy to clipboard operation
strudel copied to clipboard

basic reference with one page per function

Open felixroos opened this issue 2 years ago • 4 comments

felixroos avatar Aug 10 '23 22:08 felixroos

hmm the prebuilt reference pages are 10MB in total, just because there are so many: a total of 229 paths, each having ~40kB.. I wonder if that 10MB per build will exceed some quota or slow down the build. if yes, it should make more sense to find a way to do this dynamically.

felixroos avatar Aug 10 '23 23:08 felixroos

maybe it makes more sense to have a single reference page with anchor links? would be significantly smaller + no extra sidebar would be needed (can use right sidebar) + full text search would be much more useful

felixroos avatar Aug 11 '23 07:08 felixroos

I think the anchor links is one solution, assuming that it works better than the current solution.

However, I still think having one function per page would be better, as each page could have more information and more examples on, including links to similar/related functions. See how pure data handles that below

image

With regards to build size, could the docs be built separately?

hellocatfood avatar Aug 11 '23 15:08 hellocatfood

However, I still think having one function per page would be better, as each page could have more information and more examples on, including links to similar/related functions. See how pure data handles that below

Yep it's certainly better..

With regards to build size, could the docs be built separately?

It is already built separately but you'd still have to download everything as part of the desktop app

It would be possible to have a URL like strudel.tidalcycles.org/ref?fast which would result only in a single html file.. I'll try that

edit: if that doesn't work, it would also be possible to have a link "show more examples" or similar

felixroos avatar Aug 17 '23 09:08 felixroos