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

Changes to paper.md introduction and first section in README #29

Open
Sm00thix opened this issue Jun 20, 2024 · 2 comments
Open

Changes to paper.md introduction and first section in README #29

Sm00thix opened this issue Jun 20, 2024 · 2 comments

Comments

@Sm00thix
Copy link
Owner

Quoting @basileMarchand from the review at JOSS:

In the JOSS paper, it would be good in my opinion to have a more "simplified" introduction in the summary so that a less experienced reader can easily understand what need the package is addressing. Also, the first paragraph of the README (which is also the first paragraph of the documentation) should be made more engaging to catch the attention of readers who might be searching without really knowing what they need. This would help attract more users and build a more diverse community.

@Sm00thix
Copy link
Owner Author

Hi @basileMarchand,

I have done my best to implement the requested changes.
Please, let me know what you think.

@basileMarchand
Copy link

Hi @Sm00thix,

thank you for the work on rewriting the introduction. I think it makes the paper more engaging now because it's more accessible to people who are not specialists (they can understand what they just came across). I believe that even for you, for the dissemination of your package, this will help reach more people. Just one last suggestion, I think you could take the first 2-3 sentences of the JOSS paper summary and integrate them directly into the README, in the first section, so that anyone who comes across the IKPLS documentation or repository can immediately understand what they have found.

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

No branches or pull requests

2 participants