-
Notifications
You must be signed in to change notification settings - Fork 7
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Is your feature request related to a problem? Please describe.
Reviewer comments noted the lack of user documentation associated with both collNotes and collBook.
Describe the solution you'd like
Part of the transition from a local solution to a public one needs to incorporate detailed documentation.
- Priority should be given to end user documentation in the form of a more informative README.md.
- Help menu items in both collNotes and collBook should link to the README.md
- The "what is this" Qt features should be populated for each UI element in collBook.
- Developer documentation should also be populated in the form of structured doc strings in all appropriate functions and classes.
Describe alternatives you've considered
- an intermediate solution may be to link a recorded presentation of talk prepared for conferences.
- a YouTube video demonstrating the use from field-to-database would be an excellent supplement to these features, but it cannot replace them.
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request