Documentation Guidelines
NotZippy edited this page Apr 21, 2017
·
2 revisions
This is a general guideline of the requirements of documentation.
What we are trying do is to "integrate" the documentation, closer to the code... ie the same repos rather than some distant documentation site which is outta date and wrong version et hell+all
To demonstrate the solution its recommended that modules have their own read me
Instead its kinda requested that within each "module" or "feature" has a README.md
in markdown flavor
Development
Resources
Community