-
Notifications
You must be signed in to change notification settings - Fork 8
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
JOSS Review: where can I find the documentation? #163
Comments
There is currently no standalone documentation; instead, the documentation exists as popovers that open when clicking the question-mark icons within the running app. If you believe it's appropriate, I can add this explanation to the README file. Please let me know. |
I think the popovers are fine for user documentation, together with #166. Is there any kind of developer/API documentation? Potentially something automatically generated from comments in the code. |
Sounds good. We are working on #166 now.
Unfortunately, no. There is a bit of discussion in the README about some aspects of how the code is architected, but no formal documentation. |
I think it would be worth the time and effort investment to create a developer documentation. I don't think this is blocking for the JOSS review, but adding developer/architectural documentation would improve the long term usefulness of MaterialNet 😃 |
I agree, and as we continue to work on it, we will attempt to generate some dev docs. It would definitely be a help to the project overall! |
I did not see a link in the Readme to the documentation of this package, or instructions about how to generate this documentation locally.
The text was updated successfully, but these errors were encountered: