-
Notifications
You must be signed in to change notification settings - Fork 34
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
Update user guide contributing docs #330
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Partial review.
@lilyminium is this PR still relevant? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All looks good to me.
Even if it's not perfect — there are some suggestions that could be addressed — it would be much more useful merged than lingering as a stale PR. I suggest to merge it asap.
Co-authored-by: Rocco Meli <[email protected]> Co-authored-by: Irfan Alibay <[email protected]>
add link for pre-commit as requested by @RMeli
@lilyminium if you can confirm that the PR is still relevant then let's merge it. |
Once osmart/hole2#19 is merged, it will be sufficient to just link to the hole2 GH README for installation instructions and we can keep our UG lighter dd8000e |
Yep, this is still relevant, and I just made some minor changes in response to reviews -- thanks for having a look at this everyone! |
Co-authored-by: Rocco Meli <[email protected]>
- trim trailing whitespace - fix end of files
I am merging as it's (1) approved and (2) a big improvement over what we have. If there are any updates to be made, we can do them incrementally. |
Related to #327
This PR removes some old section and adds some information on which files are Jupyter notebooks and which are not.
📚 Documentation preview 📚: https://mdanalysisuserguide--330.org.readthedocs.build/en/330/