mljs/ml

Documentation

Opened this issue · 1 comments

malopezp91 commented

Hi guys, I would like to collaborate in this project. First, I would like to improve documentation, as some modules have none and it may be difficult to new users to use this awesome library.

What do you think?
Ideas?

targos commented

Hello Miguel. You are very welcome to help us in this big project!
There are many modules, they are not all currently functional and/or tested and it would be very useful to review the different repositories and decide if:

  • They are in a good state.
  • They are broken or outdated and need to be fixed. This may require major API changes so documentation is not the priority.
  • They are working fine but have little or no documentation.
  • They need more tests.

We just created a project to keep track of everything: https://github.com/orgs/mljs/projects/1
If you are interested, I can give you the rights to edit it. Otherwise, you can start by opening an issue in one of the repositories that you would like to enhance and we can discuss in more details what needs to be done.

Thank you!