relic-se
commented
1 month ago Hi Glenn, I appreciate the feedback.
This library does assume that the user has some level of understanding of musical theory and common keyboard/synth practices. However, I don't want the documentation to become too verbose for experienced users.
Beyond tweaks here and there to the general documentation, I think that a better solution would be to create a tutorial(s) which walks through the purpose, principles, desired outcomes, and potential hardware implementations of this library.
This is something that I would like to do, but I am not certain that I will have the time for it in the near future. If you are interested in contributing in this way to this project, I'd be happy to chat in more detail about it on the Adafruit Discord server (@dcooperdalrymple).
You have provided the usual minimal level of documentation for Adafruit libraries.
However, if a developer is not familiar with the use cases that the library supports, then even the examples are not very helpful. So, for each example's documentation, please provide a few sentences describing what it is supposed to accomplish -- for an audience that is not very familiar with the problem space. When I run the example code, what is supposed to happen? What is a "Keyboard"? What hardware do I need to make the example work? What inputs are expected and what outputs occur?
Perhaps include links to tutorial info on the subject that the example is about. How is this library different from other CircuitPython libraries for synth and MIDI?
I'd be willing to help add to the doc, but I'd have to be in conversation with you to answer a bunch of questions...