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

Improve documentation and usability #72

Open
8 tasks
vedran-kasalica opened this issue Mar 13, 2024 · 0 comments · May be fixed by #71
Open
8 tasks

Improve documentation and usability #72

vedran-kasalica opened this issue Mar 13, 2024 · 0 comments · May be fixed by #71
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@vedran-kasalica
Copy link
Member

Feature Description
The documentation and

  • Expand the description of the package purpose in README. Or point to the intro in the Documentation
  • Fix the broken link to the “usage section” of the Installation page in the documentation 
  • The notebooks for the usage examples can be more verbose. Many sections have only the title. 
  • Add API Reference (e.g. auto-generated with sphinx-autoapi
  • Do not forget to put the JOSS paper reference (once published) in README e.g. simply via badge. 
  • Ensure uniformity of in-code comment strings (a very nice example is e.g. write_tsdf.py) 
  • Write a blog post about the package 
  • Improve the RSD page, e.g. “what the package can do for you” is better eye-catches, than simply the README (especially with limited purpose description). Also “how to cite” as a prominent section. Add testimonials from the project partners. Don’t forget the JOSS paper once published. 
@vedran-kasalica vedran-kasalica added the documentation Improvements or additions to documentation label Mar 13, 2024
@vedran-kasalica vedran-kasalica linked a pull request Mar 20, 2024 that will close this issue
5 tasks
@vedran-kasalica vedran-kasalica linked a pull request Mar 20, 2024 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants