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

[docs] statement of need #254

Closed
djmannion opened this issue Jun 11, 2023 · 1 comment · Fixed by #257
Closed

[docs] statement of need #254

djmannion opened this issue Jun 11, 2023 · 1 comment · Fixed by #257

Comments

@djmannion
Copy link

(I'm a reviewer for the submission of preliz at JOSS)

This is in relation to the review criterion: "Documentation: A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?".

The initial landing page for the documentation (and also for the repo) could use an opening few sentences that meet this criterion (perhaps adapted from the paper).

@aloctavodia
Copy link
Contributor

Thanks, this is definitely something missing from the current docs.

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 a pull request may close this issue.

2 participants