search

clawpack / riemann_book

An interactive book about the Riemann problem for hyperbolic PDEs, using Jupyter notebooks.
BSD 3-Clause "New" or "Revised" License
264 stars 95 forks source link

Update README.md #232

Closed rjleveque closed 4 years ago

rjleveque commented 4 years ago

Add Contents section copied from Index.ipynb

ketch commented 4 years ago

This seems fine; I find that occasionally Github is slow to render notebooks or even fails. That mostly happens with large notebooks so probably wouldn't affect the index, but this just potentially makes it easier for some people to access.

ketch commented 4 years ago

Now that I merged it I just realized that it doesn't include the hyperlinks -- was that intended? I think we should include the links; if you agree then I can do that.

maojrs commented 4 years ago

I think we should definitely include the links.

rjleveque commented 4 years ago

I intentionally didn't include the links because linking to the notebook has the same problem David mentioned that sometimes they don't load (and this happened for me even with Index.ipynb the other day). And if it does load all they see is the input cells stripped of output, and so not so useful and potentially confusing to those not familiar with notebooks.

We could instead link to the html versions, but that's potentially confusing in other ways. Since there are other links in the README to the rendered notebooks and instructions on how to open notebooks in a way that they can execute them, I thought the purpose of putting the index here was simply so people can more easily see what's in the book without having to open anything. But I'm happy to be convinced otherwise.

On Tue, Jul 7, 2020 at 12:39 AM Mauricio J. del Razo S. < notifications@github.com> wrote:

I think we should definitely include the links.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/clawpack/riemann_book/pull/232#issuecomment-654660464, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAFPZ6RRANYIYIUMMKS4HGLR2LGIFANCNFSM4OSLYVVQ .

maojrs commented 4 years ago

Ohh I see. In that case I think it is also ok as it is now.

ketch commented 4 years ago

What if I change the chapter names in the TOC at the bottom of the README to be the actual notebook file names (in backticks), so it's completely clear which notebook is referred to?

rjleveque commented 4 years ago

@ketch - Yes, that sounds like a great solution.

ketch commented 4 years ago

Okay, I went ahead and just edited the README directly.

rjleveque commented 4 years ago

Looks good, thanks!