nasa-fornax / fornax-demo-notebooks

Demo notebooks for the Fornax project
https://nasa-fornax.github.io/fornax-demo-notebooks/
BSD 3-Clause "New" or "Revised" License
9 stars 19 forks source link

Rendering feedbacks #306

Closed bsipocz closed 2 months ago

bsipocz commented 3 months ago

These are the feedback from #205. See the comments on that PR for some narrative text. Feedback was for an early draft of the rendering, so not all may be applicable for the current version:

For the point that I don't plan to change, I added a response to the comment with the reasons.

  • [ ] Can we change the headings under the Table of Contents to be: "Photometry" (instead of "Multi-band forced photometry) and "Time Domain"
  • [ ] Then the "Photometry" heading doesn't need to be a link to a page with a link to the notebook. Since there is only one notebook in that heading, I think it is fine to not have the heading be a link. The notebook title under it will be the link.

I feel that the rendering is more consistent when have a top level topics, so would keep the current setup. I suppose we will/can revisit this question once we add the spectroscopy notebooks, too, and have more content overall. Also, would keep something about "forced photometry" as the light curves are also about photomerty.

  • [ ] Inside the rendered notebooks, I don't need the orange # that appears next to the headings when I hover over them and appears to move that section to the top. This is just a preference and not a strong opinion.

The anchors for the headings are standard part of the theme (in fact any theme) and are used for the navigation from the right hand side TOC. I'm not sure how to make them in a different colour.

  • [ ] For the forced photometry rendered notebook, the section heading doesn't appear to have worked for section 2. I think "Use fornax cloud access API..." should be 2.1, etc. Sorry if this is a problem with the original notebook, and leet me know if you want me to change anything in the .md file

Unfortunately, doing the heading numbering automatically does not work with the rendering, there are long open feature requests for this in the various packages we use under the hood. So at the moment all of the numbers are coming from hand written headings. (And those will look really ugly in jupyerlab when working with the notebooks as automated numbering works there.) So, we either fix the manual numbering everywhere, or remove the currently added numbers. I would lean for the latter, as in the rendered version the right hand side TOC I think works nice without the numbers, but we can also add the number if you would like that. Either case, this deserves its own issue, so I'm opening one: https://github.com/nasa-fornax/fornax-demo-notebooks/issues/343

  • [ ] the top menu which has the symbols for github, binder, print, etc. needs to be clicked on to click on the option within the menu, ie., you need to click on the main image, then on the option you want. Which is one click too many if that is customizable. (This works the way I expect, with a single click, on the epyc website)

I think we had a version with the older template, the current one seems to be the desired version (and I also would like to avoid doing much theme customisation)

  • [ ] the pdf print option for the notebooks prints the table of contents, is it possible to not print the table of contents, and just the notebooks?

Currently the PDF doesn't seem to include the sidebars.

bsipocz commented 2 months ago

OK, so all the points are either addressed or I responded why didn't do a change. For any new rendering related feedback, please open a new issue.