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 documentation for applications of Casanovo #418

Merged
merged 6 commits into from
Dec 16, 2024
Merged

Conversation

melihyilmaz
Copy link
Collaborator

Added a new readthedocs page with links to papers using Casanovo, with one sentence descriptions for each.

Addresses issue #415

@melihyilmaz melihyilmaz requested a review from wsnoble December 11, 2024 17:23
Copy link
Contributor

@wsnoble wsnoble left a comment

Choose a reason for hiding this comment

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

Looks good. Let's see if Wout also wants to review it before merging.

Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.77%. Comparing base (c128c7d) to head (b100842).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #418   +/-   ##
=======================================
  Coverage   89.77%   89.77%           
=======================================
  Files          12       12           
  Lines         929      929           
=======================================
  Hits          834      834           
  Misses         95       95           

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

@bittremieux
Copy link
Collaborator

Should we include some more information about the applications (authors, year, journal) for better referencing?

@bittremieux bittremieux linked an issue Dec 13, 2024 that may be closed by this pull request
@bittremieux
Copy link
Collaborator

Maybe also add a "Last updated on XXX." statement at the bottom, because you run the risk that this quickly becomes outdated.

Additionally, something like "Contact us with your applications of Casanovo to feature your research here", and some instructions on how they should do that through GitHub maybe?

@wsnoble
Copy link
Contributor

wsnoble commented Dec 13, 2024

I like all three of Wout's suggestions. Melih, will you please make these changes?

@melihyilmaz
Copy link
Collaborator Author

Thanks Wout, I made the changes.

@bittremieux bittremieux merged commit 5d06bea into main Dec 16, 2024
5 checks passed
@bittremieux bittremieux deleted the applications-docs branch December 16, 2024 15:24
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.

Create documentation page listing related citations
3 participants