Add a Tour of flatsurf - Githubissues

flatsurf / sage-flatsurf

Flat surfaces in Sage

https://flatsurf.github.io/sage-flatsurf/

GNU General Public License v2.0

10 stars 10 forks source link

Add a Tour of flatsurf #254

Closed saraedum closed 2 months ago

saraedum commented 10 months ago

fixes #253

TODO

[x] Added an entry in doc/news/.
[x] Added a test for this change.
[x] Added new .py files to the documentation in doc/geometry or doc/graphical.
[x] Split cells that produce multiple outputs. Just make sure that each logical section is self-contained.
[x] Increase the picture density when scrolling through the tour.
[x] Link to the tour prominently on the sage-flatsurf GitHub page.
[x] Link to the tour prominently on flatsurf.github.io.

Dependencies

[x] https://github.com/flatsurf/veerer/issues/23

videlec commented 10 months ago

I expanded quite a bit the "veerer" part that Martin Möller and Johannes Schwab want to use. Can I commit now?

saraedum commented 10 months ago

I expanded quite a bit the "veerer" part that Martin Möller and Johannes Schwab want to use. Can I commit now?

Yes, please update the tour.md file.

videlec commented 10 months ago

The output of the cell

# you might need to install veerer
# (it is not by default in the flatsurf stack... but soon)
# the command could equally be run in a console
%pip install git+https://github.com/flatsurf/veerer

is a bit ugly :-)

saraedum commented 10 months ago

Yeah, let's create a veerer release, https://github.com/flatsurf/veerer/issues/23 and https://github.com/conda-forge/staged-recipes/pull/24458.

github-actions[bot] commented 2 months ago

Documentation preview for this PR is ready! :tada: Built with commit: 0232437ad85a5bd6865ba1c34efd76575a697d98

saraedum commented 2 months ago

@videlec @slel anything else that should be added to the tour? https://deploy-preview-254--cheerful-kulfi-d8aab6.netlify.app/examples/tour

videlec commented 2 months ago

@videlec @slel anything else that should be added to the tour? https://deploy-preview-254--cheerful-kulfi-d8aab6.netlify.app/examples/tour

Yes. I would like to expand the veerer part (at least mentioning #269).

videlec commented 2 months ago

@videlec @slel anything else that should be added to the tour? https://deploy-preview-254--cheerful-kulfi-d8aab6.netlify.app/examples/tour

Yes. I would like to expand the veerer part (at least mentioning #269).

Though this is waiting for https://github.com/flatsurf/veerer/pull/46

saraedum commented 2 months ago

Should we merge this already and then keep adding things to the tour when we merge them into the actual packages (and release them?)

videlec commented 2 months ago

Should we merge this already and then keep adding things to the tour when we merge them into the actual packages (and release them?)

Sounds good to me.