New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Link dev docs from specific modules #198

Open

3 tasks

brynwhyman opened this issue May 17, 2019 · 0 comments

Labels

affects/v4 complexity/medium impact/medium type/docs

brynwhyman commented May 17, 2019

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

brynwhyman added affects/v4 change/patch complexity/medium impact/medium type/docs labels

emteknetnz removed the change/patch label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment