Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

split MDAKit tutorial into sub-pages #156

Open
orbeckst opened this issue Jul 11, 2024 · 2 comments
Open

split MDAKit tutorial into sub-pages #156

orbeckst opened this issue Jul 11, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@orbeckst
Copy link
Member

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.

@orbeckst orbeckst added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 11, 2024
@IAlibay IAlibay removed the good first issue Good for newcomers label Jul 11, 2024
@IAlibay
Copy link
Member

IAlibay commented Jul 11, 2024

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
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants