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

basic reference with one page per function #661

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from
Draft

Conversation

felixroos
Copy link
Collaborator

No description provided.

@felixroos
Copy link
Collaborator Author

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

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

@hellocatfood
Copy link

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?

@felixroos
Copy link
Collaborator Author

felixroos commented Aug 17, 2023

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 felixroos marked this pull request as draft January 18, 2024 09:30
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