scf4 / callbaxx

[Satire]πŸ”₯ JS utility library to bring classic callback style programming to synchronous code β€”Β ES6? More like ES Sucks.
MIT License
9 stars 1 forks source link

Better docs page β€” Help needed #15

Open scf4 opened 5 years ago

scf4 commented 5 years ago

As Callbaxx.js grows into a fully-featured library, it will soon become necessary to move the docs out of the README file and into a separate docs page.

This would also let people know that this is a serious and reliable FOSS project with plenty of community backing.

For now I think we should use JS/ESDoc to document each function, then we can generate basic docs from that.

Feel free to add declarations with params to any file in the lib/ dir which doesn't yet have them (i.e., most).

Be a part of something big and contribute to this game-changing project while we still have low standards for PRs! πŸ˜„