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

Add more documentation #9

Closed
cthoyt opened this issue Oct 25, 2024 · 1 comment
Closed

Add more documentation #9

cthoyt opened this issue Oct 25, 2024 · 1 comment

Comments

@cthoyt
Copy link
Contributor

cthoyt commented Oct 25, 2024

Right now, the documentation seems to just be demo files in https://github.com/darrenjw/jax-smfsb/tree/main/demos. This isn't sufficient to motivate why the package exists and to onboard a new user - the documentation in https://jax-smfsb.readthedocs.io/en/latest/index.html should be more extensive and ideally linked with a ReadTheDocs badge like most python packages do.

Please watch Daniele Procida's great talk on how to think about writing good documentation: https://youtu.be/azf6yzuJt54?si=GzIWdr8-24KCXfVP

@darrenjw
Copy link
Owner

I've added a tutorial document for ReadTheDocs, and a RTD badge.

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