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

Add user guide to docs, restructure some other documentation pages #166

Merged
merged 5 commits into from
Aug 18, 2023

Conversation

dotsdl
Copy link
Member

@dotsdl dotsdl commented Aug 17, 2023

Closes #28.

This PR seeds the user guide portion of the alchemiscale docs.
We draw from the user instructions drafted here: https://openforcefield.atlassian.net/wiki/spaces/IN/pages/2566586394/Protein-Ligand+Binding+Free+Energy+Benchmarks+via+alchemiscale

@codecov-commenter
Copy link

codecov-commenter commented Aug 17, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (2dca4d0) 82.45% compared to head (e40968b) 82.45%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #166   +/-   ##
=======================================
  Coverage   82.45%   82.45%           
=======================================
  Files          21       21           
  Lines        2679     2679           
=======================================
  Hits         2209     2209           
  Misses        470      470           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

'gufe': ('https://gufe.readthedocs.io/en/latest/', None),
'openfe': ('https://docs.openfree.energy/en/stable/', None),
'perses': ('https://perses.readthedocs.io/en/latest/', None)
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I one nit, sort this dict by keys and add a trailing comma, so when we add to this list the diff is clean

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Done!

@dotsdl dotsdl merged commit b831756 into main Aug 18, 2023
4 checks passed
@dotsdl dotsdl deleted the user-guide branch September 26, 2024 06:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs : user guide
3 participants