Ooph. Caught red-handed.
It’s something that definitely needs work. There’s a section on the website with code snippets for extending Edit Flow, but standard documentation is lacking.
If you ever have a few minutes and wish to pay this one forward, would be great to have a PR to kick off the documentation process. Maybe just documenting one of the functions in that gist get_usergroup_by
or get_following_usergroups
.
Bare bones, I’d imagine in Github the documentation structure might look like:
- common
- language
- modules
- tests
- docs
- edit_flow.md (documenting functions, their arguments, return values and use cases)
- modules
- notifications.md (documenting functions, their arguments, return values and use cases)
- user-groups.md (documenting functions, their arguments, return values and use cases)
But open to suggestions.