asinghvi17
commented
1 year ago Here's a list of todos which should encapsulate exactly what has to happen here:
- adding the reference tests as their own category, so they're still integrated and searchable but somewhat separate.
- enforcing the BeautifulMakie Literate.jl programming style for longer examples, which is really good.
- allowing multiple tags.
- creating the front page as a searchable, scrollable gallery, which has elements that redirect you to the appropriate page when clicked on.
In general, examples should:
- Work when copy-pasted. That means that most assets should be located in the Makie monorepo, within reason, or accessed through
Downloads.download. - Be (mostly) backend-independent, i.e. using
Makie.*instead ofGLMakie.*. - Not visibly call functions which affect global state, i.e.,
activate!, unless necessary (these should be hidden) - There should be an interface where examples can declare their tags, and some autogeneration should be done, for example to show the package versions.
lazarusA
e.g. https://texample.net does this, where you can see a preview of each example on a single page, then click on it. We used to have that in MakieGallery as well, which is still up at https://juliaplots.github.io/MakieReferenceImages/gallery !
It would be great to have something like that here, as a welcoming front page. We could also possibly incorporate the documentation example plots in here, by parsing the docs!