Adaptation instructions

[mslinn]

Reading through instructions for creating new adaptations, I was most impressed with the thoughtfulness that provides users with the ability to create new adaptations. I was also pleasantly surprised with the quality of the documentation: it is clear and well-organized.

I have a documentation error to point out, and 2 suggestions:

Documentation Error

The KnobKraft Orm Adaptation Programming Guide shows a large image with 4 buttons, 2 of which are labeled Set User Adaption Dir and Create new adaptation.

None of the four buttons shown appear there any longer. The two buttons circled in red seem to have been moved to the Options / Set user adaptation dir menu. I do not know where the other 2 buttons went.

Suggestion 1

The Options / Set user adaptation dir menu item shows that the adaptation files are stored on Windows in %systemdrive%%homepath%\KnobKraft-Adaptations; Instead of a hard-coded path, I used the universally applicable pre-defined Windows environment variables. Pasting this value into File Explorer on my computer takes me to C:\Users\Mike Slinn\KnobKraft-Adaptations. I would like to suggest that the value that uses Windows environment variables be displayed in the documentation and in the dialog.

Suggestion 2

How might people contribute pull requests from their adaptions? The most manageable approach would require the user to fork the KnobKraft-orm repository.

One way to do this would be to add a new menu item that would convert the user adaptation directory into a git repository containing a Partial Clone With Sparse Checkout of the KnobKraft-orm fork. The GitHub command line tool can provide the necessary functionality, and it is available as a Python library. A second new Knobcraft menu item would create a pull request for the new adaptation.