Link dev docs from specific modules - Githubissues

silverstripe / cwp

Common Web Platform (CWP) features module. We strongly recommend using it for all new CWP projects. Future features will be delivered here.

https://www.cwp.govt.nz

BSD 3-Clause "New" or "Revised" License

10 stars 26 forks source link

Link dev docs from specific modules #198

Open brynwhyman opened 5 years ago

brynwhyman commented 5 years ago

There are a number of feature or module specific developer guides that are captured in https://github.com/silverstripe/cwp/tree/master/docs/en/02_Features, and surfaced through cwp.govt.nz, but are not referenced in the specific modules.

If a developer comes across the modules through GitHub or the Addons site, there is no clear path for finding this information.

[ ] For exisiting developer documentation that exists, ensure it is referenced in a module readme
[ ] Identify modules that may not have sufficient documentation in cwp.govt.nz or ss.org
[ ] Raise issues of specific modules to improve the developer guidance