Git Product home page Git Product logo

Comments (2)

james7132 avatar james7132 commented on June 1, 2024

Indeed, I have looked into it since you first mentioned it in the reddit comment.

It would definitely be helpful to have some proper documentation of the code (As there currently is none).

The idea to use it with Github pages is a great one. I originally was thinking of putting a dev blog there, but this may work even better for the purposes of development.

There seems to also be a plugin specifically for this kind of documentation generation.

from fantasycrescendo.

KazeSenshi avatar KazeSenshi commented on June 1, 2024

Even without the plugin we could use a GUI-based documentation generator. The most important thing for now is to say to any contributor to follow its syntax. When I have time I'll document better my code.

from fantasycrescendo.

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.