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.

Sign up for GitHub

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

Jump to bottom

Add general project documentation #18

Closed
jatkinson1000 opened this issue Feb 28, 2023 · 2 comments
Closed

Add general project documentation #18

jatkinson1000 opened this issue Feb 28, 2023 · 2 comments
Labels
code review Resulting from Feb 2023 code review documentation Improvements or additions to documentation
Milestone
First release del...

Comments

@jatkinson1000
Copy link
Member

jatkinson1000 commented Feb 28, 2023 •
edited by dorchard
Loading

Add project documentation in README.md to address:

Do we need more detail? Sphinx or readthedocs? Probably not at the moment.
@jatkinson1000 jatkinson1000 mentioned this issue Feb 28, 2023
Closed
@jatkinson1000 jatkinson1000 added documentation Improvements or additions to documentation code review Resulting from Feb 2023 code review labels Feb 28, 2023
@raehik raehik mentioned this issue Mar 27, 2023
Closed
@dorchard dorchard mentioned this issue May 12, 2023
Merged
@MarionBWeinzierl
Copy link
Collaborator

MarionBWeinzierl commented Jul 20, 2023 •
edited
Loading

Some of this was addressed in #60 .

Still to do:

  • A CITATION.cff file could be added providing a formatted citation snippet. (alternatively: section in README)
  • More information on the model outputs should be provided.

@raehik raehik mentioned this issue Dec 4, 2023
Open
@raehik
Copy link
Contributor

raehik commented Dec 4, 2023 •
edited
Loading

CITATION.cff added in #99. I've elaborated on your model documentation in #106 -- in short, it exists in the paper, but it doesn't discuss implementation details, so we should add those.

Otherwise, with the readme expanded (and some extra stuff pending in #97), I think this issue is OK to close.

@raehik raehik changed the title Add project documentation Add general project documentation Dec 4, 2023
@raehik raehik closed this as completed Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code review Resulting from Feb 2023 code review documentation Improvements or additions to documentation
Projects
None yet
Milestone
First release deliverable: reusable c...
Development

No branches or pull requests
4 participants
@raehik @mondus @MarionBWeinzierl @jatkinson1000