feat(docs): Added a page on module creation #2456
Conversation
Nick-Munnich
force-pushed
the
module-creation
branch
from
c7c0df8
to
d61d8e7
Compare
There was a problem hiding this comment.
I think it is worth considering dropping the vfx category from the initial version, since it seems unclear to me how they'd be implemented right now (let me know if I am missing something).
Looks good to me as a document overall and I agree with the implementation guidelines in general. There are some of the more subjective statements which I didn't review, like the first sentence.
That being said, will this wait until some sort of ZMK versioning is in place?
|
|
||
| | | `keyboards` | `components` | `behavior` | `driver` | `feature` | `vfx` | | ||
| | ---------------- | ----------- | ------------ | ---------- | -------- | --------- | ----- | | ||
| | `board/` | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ | |
There was a problem hiding this comment.
Would vfx need boards? I guess that category is a bit up in the air right now given it isn't clear how it'd be implemented.
There was a problem hiding this comment.
The example I have in my head for said category is your RGB-LED module. I agree the details of the category would need some more work once ZMK's features around the area are more mature.
There was a problem hiding this comment.
Ah, I guess I'd consider it a feature if I had to classify.
There was a problem hiding this comment.
Perhaps the classification there could use some additional distinction, but I'm also not sure what a better split would be. I'd certainly put it into vfx as it communicates stuff visually.
There was a problem hiding this comment.
I had considered the description to be more literal, like underglow effects & display/LVGL widgets -- I can see the rgbled-widget fitting under a similar context.
Co-authored-by: Cem Aksoylar <[email protected]>
There was a problem hiding this comment.
There are some of the more subjective statements which I didn't review, like the first sentence.
Would be good to have a bit of discussion on those I think.
That being said, will this wait until some sort of ZMK versioning is in place?
The collection repo yes, but enough people seem to already be using the preview as a reference that I think it'd be worthwhile pushing through a trimmed down version of the page prior to versioning.
|
|
||
| | | `keyboards` | `components` | `behavior` | `driver` | `feature` | `vfx` | | ||
| | ---------------- | ----------- | ------------ | ---------- | -------- | --------- | ----- | | ||
| | `board/` | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ | |
There was a problem hiding this comment.
The example I have in my head for said category is your RGB-LED module. I agree the details of the category would need some more work once ZMK's features around the area are more mature.
Added a page on module creation, much nicer this time.
This page makes use of another repository,
zmk-module-template, which we should fork into the project if this approach is approved.This page also makes reference to a second repository,
zmk-modules. Work regardingzmk-modulesis still in progress, but it is there to read and provide feedback on. If this is merged beforezmk-modulesis ready, then I suggest we comment out the parts onzmk-modulesfor the time being.