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 statement of need to documentation home page #18

Closed
ashiklom opened this issue Oct 26, 2020 · 1 comment · Fixed by #22
Closed

Add statement of need to documentation home page #18

ashiklom opened this issue Oct 26, 2020 · 1 comment · Fixed by #22

Comments

@ashiklom
Copy link

Per the JOSS recommendations, the documentation should address, "Do the authors clearly state what problems the software is designed to solve and who the target audience is?". I would recommend doing this in 1-3 sentences on the documentation home page. The JOSS paper does this pretty well, so you could just lift the text directly from that.

(Part of JOSS review, openjournals/joss-reviews#2766).
@ashiklom ashiklom mentioned this issue Oct 28, 2020
Closed
40 tasks
@znicholls znicholls mentioned this issue Oct 31, 2020
Merged
4 tasks
@znicholls
Copy link
Contributor

Thanks again! Fix in #22

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add statement of need to README openscm/openscm-twolayermodel
2 participants
@ashiklom @znicholls