JuliaManifolds / Manifolds.jl

Manifolds.jl provides a library of manifolds aiming for an easy-to-use and fast implementation.
https://juliamanifolds.github.io/Manifolds.jl
MIT License
368 stars 53 forks source link

Move tutorials to Quarto #638

Closed mateuszbaran closed 1 year ago

mateuszbaran commented 1 year ago

I've moved hand gesture tutorial to Quarto, I think it makes it easier to discover. And Quarto is nice.

I'm thinking about moving the chart/atlas tutorials but then we would lose all interactivity.

codecov[bot] commented 1 year ago

Codecov Report

Merging #638 (e5a966e) into master (6168554) will decrease coverage by 0.06%. The diff coverage is n/a.

:exclamation: Current head e5a966e differs from pull request most recent head 8af3b5b. Consider uploading reports for the commit 8af3b5b to get more accurate results

@@            Coverage Diff             @@
##           master     #638      +/-   ##
==========================================
- Coverage   99.20%   99.14%   -0.06%     
==========================================
  Files         106      106              
  Lines       10215    10210       -5     
==========================================
- Hits        10134    10123      -11     
- Misses         81       87       +6     

see 8 files with indirect coverage changes

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

mateuszbaran commented 1 year ago

Hm, GLMakie.jl doesn't work on CI. @kellertuer , what do you think about rendering images locally and uploading them? How should I do that?

kellertuer commented 1 year ago

I think there are two possibilities, either pretender just the one image and load it in the file or quarto render the whole example, commit the md file and the rendered images.

I would prefer the second I think, and do the same with two tutorials in Manopt.jl as well, you just have to exclude them then here in the _quarto.yml, see https://github.com/JuliaManifolds/Manopt.jl/blob/master/tutorials/_quarto.yml

You can also see that both markdown files and some images are actually committed https://github.com/JuliaManifolds/Manopt.jl/tree/master/docs/src/tutorials

For the regression example the reason is the same as yours, we do not have Asymptote on CI, the other one just runs too long on CI.

mateuszbaran commented 1 year ago

I went with the first option, it looks a bit easier.

kellertuer commented 1 year ago

I will try to find time to review this tomorrow. At first glance: You created two quarto notebooks but only deleted one old jl file. What about the other one?

mateuszbaran commented 1 year ago

I haven't deleted the "working in charts" .jl file because it still has some interactivity parts that couldn't be ported to the Quarto version.

mateuszbaran commented 1 year ago

Here are a few comments, overall – nice to have them in the new format. I hope we get a few more somewhen (maybe one on metrics, one on Lie,...)

Yes, Quarto looks nice. I think I will keep using it for new tutorials.

kellertuer commented 1 year ago

In VS Code there is also a live html preview (Live as in re-render per save action, not as live as Pluto). Then writing these tutorials is very nice – and I feel a bit better fitting than Pluto even.