This repository was archived by the owner on Sep 4, 2022. It is now read-only.
This repository was archived by the owner on Sep 4, 2022. It is now read-only.
Documentation modules #4
Description
Documentation
Modules are working and ready to use.
It would be sad if the only one able to use them was me.
Documentation is key: just describe the usage process and briefly how the methods work.
A good doc
The final user should know, in descending order of importance :
- README module:
- module information
- usage tutorial
- developer instruction
- Inside file with jsdoc:
- classes/functions description
- methods description
To sum up things:
- a clean and simple README of all the modules
would be perfect: give an introduction without becoming module-specific.