Git Product home page Git Product logo

Comments (5)

waxlamp avatar waxlamp commented on July 23, 2024

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.

from materialnet.

Luthaf avatar Luthaf commented on July 23, 2024

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.

from materialnet.

waxlamp avatar waxlamp commented on July 23, 2024

I think the popovers are fine for user documentation, together with #166.

Sounds good. We are working on #166 now.

Is there any kind of developer/API documentation? Potentially something automatically generated from comments in the code.

Unfortunately, no. There is a bit of discussion in the README about some aspects of how the code is architected, but no formal documentation.

from materialnet.

Luthaf avatar Luthaf commented on July 23, 2024

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 😃

from materialnet.

waxlamp avatar waxlamp commented on July 23, 2024

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 smiley

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!

from materialnet.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.