Giter Site home page Giter Site logo

Comments (4)

KonradHoeffner avatar KonradHoeffner commented on August 23, 2024 1

Thanks! I will check the appropriate box in the review, however I will leave this issue open as you said there is still missing documentation.

from debeir.

Ayuei avatar Ayuei commented on August 23, 2024

Can you clarify what you mean by "how it is generated", does this mean the tool/library used to generate the documentation?

from debeir.

KonradHoeffner avatar KonradHoeffner commented on August 23, 2024

Yes, it would be nice to know after checking out the repository, how to generate the documentation.
But it doesn't need another full sentence, for example you could extend "Otherwise, html rendered documentation is available here" to something like "Otherwise, documentation generated by python insertdoctoolhere is available here."
HTML should be uppercase if you keep it.

from debeir.

Ayuei avatar Ayuei commented on August 23, 2024

Hi, I added more documentation for all the components and added more examples for usage. I'll continually update this as there are still some spelling mistakes and missing documentation. But the core documentation should be there for users to get started.

I also included in the README.md how the documentation is generated and how to generate it yourself.

from debeir.

Related Issues (13)

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.