First of all, thanks a lot for documenting LocalDistinguishability on the wiki.
In an ideal workflow, documentation should go hand by hand with the code, that is, there should be documentation changes in each Pull Request where you change the signature of the functions in the code. I am opening this issue to discuss a way to automatize documentation.
As we discussed by email, this is not a priority, but I believe it's still good to write down potential solutions:
- Mediawiki as it is now (source on Github)
- MATLAB documentation hosted on Github Pages
- readme.io
- free for open source projects
(more pro and cons to be added)
First of all, thanks a lot for documenting LocalDistinguishability on the wiki.
In an ideal workflow, documentation should go hand by hand with the code, that is, there should be documentation changes in each Pull Request where you change the signature of the functions in the code. I am opening this issue to discuss a way to automatize documentation.
As we discussed by email, this is not a priority, but I believe it's still good to write down potential solutions:
(more pro and cons to be added)