openmm / openmm-cookbook

The OpenMM Cookbook and Tutorials
35 stars 10 forks source link

Add tutorials #16

Closed sef43 closed 1 year ago

sef43 commented 1 year ago
github-actions[bot] commented 1 year ago

Example docs for this PR rendered here

peastman commented 1 year ago

Is the above link supposed to work? It produces a 404.

sef43 commented 1 year ago

Is the above link supposed to work? It produces a 404.

It is supposed to, but it doesn't work, also gives me 404

sef43 commented 1 year ago

@peastman the link for the rendered PR now works: https://openmm.github.io/openmm-cookbook/PR16/index.html

peastman commented 1 year ago

It still presents them on a single page titled "The OpenMM Cookbook and Tutorials".

sef43 commented 1 year ago

They are now more separate on https://openmm.github.io/openmm-cookbook/PR16/index.html The links https://openmm.github.io/openmm-cookbook/PR16/cookbook.html and https://openmm.github.io/openmm-cookbook/PR16/tutorials.html Link directly to pages with just the cookbook recipes and the tutorials on respectively. Once merged and released these will be https://openmm.github.io/openmm-cookbook/latest/cookbook.html https://openmm.github.io/openmm-cookbook/latest/tutorials.html Which we can link from the openmm.org webpage

sef43 commented 1 year ago

@peastman @jchodera Are you happy with the setup?, the index page has separate links to the cookbook and tutorials pages. These separate pages can be directly linked to: cookbook, tutorials

peastman commented 1 year ago

Sorry for not getting to this sooner! It's looking good. How do you envision integrating this with the rest of the website? Currently the tutorials are their own tab, while the cookbook is linked from the documentation tab. Do we want to keep that organization? Should the tutorials become another link from the documentation tab? Should the cookbook and/or tutorials be added to the sidebar in the other documentation (see for example http://docs.openmm.org/latest/userguide/)?

sef43 commented 1 year ago

Sorry for not getting to this sooner! It's looking good. How do you envision integrating this with the rest of the website? Currently the tutorials are their own tab, while the cookbook is linked from the documentation tab. Do we want to keep that organization? Should the tutorials become another link from the documentation tab? Should the cookbook and/or tutorials be added to the sidebar in the other documentation (see for example http://docs.openmm.org/latest/userguide/)?

I think the cleanest would be to add a new box/link on the documentation page for the tutorials: https://openmm.org/documentation, and remove the tutorial tab here https://openmm.org/tutorials

And we can also add links to the cookbook and tutorials to the documention sidebar. I just need to do a bit more clean-up on this PR, then I will merge it, and then when the https://openmm.github.io/openmm-cookbook/latest links are live I will PR those changes to the Docs and webpage

peastman commented 1 year ago

That sounds reasonable.

A very minor bug: on the tutorials page, the label at the top left says "OpenMM Cookbook" instead of "OpenMM Tutorials".

sef43 commented 1 year ago

A very minor bug: on the tutorials page, the label at the top left says "OpenMM Cookbook" instead of "OpenMM Tutorials".

I've changed the top left label by the OpenMM logo to read "OpenMM Cookbook and Tutorials", The sidebar navigation and main page title makes it clear if you are in the cookbook or the tutorials, I don't think its possible so set it differently for each page given they are being built in the same sphinx document.