Skip to content

Proper user and developer documentation needs to be provided #8

@CapPow

Description

@CapPow

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

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions