We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
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
The text was updated successfully, but these errors were encountered:
I've added a tutorial document for ReadTheDocs, and a RTD badge.
Sorry, something went wrong.
No branches or pull requests
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
The text was updated successfully, but these errors were encountered: