libreform / wp-libre-form

Easy native HTML5 forms for WordPress. Version 1.5 is unmaintained, but works without issue. 2.0 has been rewritten from the ground, and can be found at https://github.com/libreform/libreform
https://wordpress.org/plugins/wp-libre-form
GNU General Public License v3.0
67 stars 27 forks source link

Improve documentation #86

Open timiwahalahti opened 6 years ago

timiwahalahti commented 6 years ago

We need to improve inline documentation and also open a GitHub wiki that documents every hook properly.

anttiviljami commented 6 years ago

I'm against using Github wiki for documentation. Add API.md or something instead so we can keep docs in source control.

k1sul1 commented 6 years ago

Just add docblocks and autogenerate the docs, publish on ghpages.

One addition to composer.json:

"phpdoc": "phpdoc -n -t docs -d modules --template=\"responsive-twig\"; git add docs; git commit -m \"Update documentation\""

timiwahalahti commented 5 years ago

At the same time, let's introduce better changelog as keepachangelog.com that contains also Unreleased section.