MDAnalysis / MDAKits

The MDAnalysis Toolkits Registry
https://mdakits.mdanalysis.org
Other
15 stars 24 forks source link

split MDAKit tutorial into sub-pages #156

Open orbeckst opened 1 month ago

orbeckst commented 1 month ago

The MDAKits Tutorial contains all necessary information but feedback from users indicates that it is overwhelming in its monolithic one-page presentation. We should make it more approachable by splitting it into separate pages.

The current page can be the overview and contain a TOC with individual sections.

IAlibay commented 1 month ago

I'm removing the good first issue because it will involve more coordination than what I would want to subject a new contributor. I'm assigning @fiona-naughton though who will have their own views on how to achieve this.

orbeckst commented 1 month ago

My initial thought was that a simple refactor into separate pages would be an improvement. That can be done in the docs itself and only requires working with sphinx.

I’m happy if @fiona-naughton wants to do it but would also happily review a PR from anyone else.