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

Statement of need not found in documentation #124

Closed
ojeda-e opened this issue Nov 29, 2021 · 2 comments · Fixed by #125 or #131
Closed

Statement of need not found in documentation #124

ojeda-e opened this issue Nov 29, 2021 · 2 comments · Fixed by #125 or #131
Labels
joss-review OpenCADD-KLIFS JOSS review

Comments

@ojeda-e
Copy link
Contributor

ojeda-e commented Nov 29, 2021

Hi @dominiquesydow

For the current JOSS review, a statement of need should be in both documentation pages and the paper associated with the OpenCADD-KLIFS repository. Currently, I can find the statement of need as a section in this source but not in the provided documentation.

Maybe I am missing it. Would you please share the link where a statement of need in docs is included?

Thanks.

@dominiquesydow
Copy link
Contributor

Hi @ojeda-e,

Thank you for pointing this out; the statement is missing in the documentation.

I suggest adding the "Statement of need" to our docs like this:
https://opencadd.readthedocs.io/en/klifs-stat-of-need/databases_klifs_statement_of_need.html

I copied the paper text, please let me know if this is in compliance with the JOSS requirements for the documentation.

At the moment, the changes are part of PR #125. Happy to merge if you approve of the changes.

@dominiquesydow dominiquesydow linked a pull request Nov 30, 2021 that will close this issue
3 tasks
@dominiquesydow dominiquesydow reopened this Dec 7, 2021
@dominiquesydow dominiquesydow added the joss-review OpenCADD-KLIFS JOSS review label Dec 7, 2021
@dominiquesydow dominiquesydow linked a pull request Dec 7, 2021 that will close this issue
2 tasks
dominiquesydow added a commit that referenced this issue Dec 7, 2021
OpenCADD-KLIFS: Sync stat. of need in paper with docs (issue #124)
@dominiquesydow
Copy link
Contributor

Hi @ojeda-e, the statement of need is now in-sync between our documentation and paper. This issue was closed automatically with the PR merges; please re-open if anything is left to update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
joss-review OpenCADD-KLIFS JOSS review
Projects
None yet
2 participants