feat(docs): Add New Behavior Guide #1268
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-Authored-By: Henré Botha <henrebotha@gmail.com> Co-Authored-By: Cem Aksoylar <caksoylar@users.noreply.github.com> Co-Authored-By: Dom H <dom@hxy.io>
caksoylar
approved these changes
May 2, 2022
kurtis-lew
commented
May 2, 2022
|
|
||
| LOG_MODULE_DECLARE(zmk, CONFIG_ZMK_LOG_LEVEL); | ||
|
|
||
| #if DT_HAS_COMPAT_STATUS_OKAY(DT_DRV_COMPAT) |
There was a problem hiding this comment.
Planning to rewrite this section given the review done by @joelspadin in #1275.
#1275 (comment)
There was a problem hiding this comment.
Leave it for a separate MR maybe? I think it would be good to just get this merged and then follow up.
henrebotha
approved these changes
May 2, 2022
dxmh
reviewed
May 3, 2022
There was a problem hiding this comment.
Awesome guide – looks great to me from a docs point of view!
As mentioned in #1174 (review), I think it would be good to get approval from at least one developer contributor familiar with the more technical aspects. Maybe @petejohanson, @joelspadin or @okke-formsma could take a glance over this and give a thumbs up before we merge?
okke-formsma
reviewed
May 3, 2022
okke-formsma
reviewed
May 3, 2022
okke-formsma
reviewed
May 3, 2022
okke-formsma
reviewed
May 3, 2022
okke-formsma
reviewed
May 3, 2022
dxmh
added
documentation
- Address Event Manager review comments by @okke-formsma - Update PR section to link to contributor documentation
dxmh
approved these changes
May 11, 2022
petejohanson
requested changes
May 17, 2022
kurtis-lew
force-pushed
the
behavior_guide
branch
3 times, most recently
from
f9747f2
to
71f6c67
Compare
- Update hardware testing section - Add note to update app/dts/behaviors.dtsi Co-Authored-By: Pete Johanson <peter@peterjohanson.com>
kurtis-lew
force-pushed
the
behavior_guide
branch
from
71f6c67
to
a04c599
Compare
kurtis-lew
force-pushed
the
behavior_guide
branch
from
826ef97
to
523ae83
Compare
kurtis-lew
changed the title
kurtis-lew
force-pushed
the
behavior_guide
branch
from
50cd342
to
02b611e
Compare
petejohanson
approved these changes
May 19, 2022
There was a problem hiding this comment.
This is awesome. @dxmh or @caksoylar can weight in/approve and merge when they're ready.
kurtis-lew
force-pushed
the
behavior_guide
branch
from
02b611e
to
052c700
Compare
👷 Deploy request for zmk accepted.
|
kurtis-lew
force-pushed
the
behavior_guide
branch
from
2082fe5
to
8518149
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Co-Authored-By: Henré Botha henrebotha@gmail.com
Co-Authored-By: Cem Aksoylar caksoylar@users.noreply.github.com
Co-Authored-By: Dom H dom@hxy.io
This PR adds a guide for developers wishing to create new behaviors for ZMK. The behavior guide is largely inspired by the new shield guide, and shows users how to: