docs: Streamlined the new shield guide #2515
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
caksoylar
reviewed
Sep 30, 2024
There was a problem hiding this comment.
While I have some notes, I think this page really needed straightening up and this is great overall. Thanks!
As an aside, cosmetically, it'd be nice to have empty lines in some places where tags like <TabItem> are used, e.g. one before open tag and one after close.
Nick-Munnich
commented
Sep 30, 2024
caksoylar
approved these changes
Sep 30, 2024
|
Also, all four points in your future plans sounds good and necessary to me. Thanks again for cleaning up this page! |
Nick-Munnich
force-pushed
the
new-shield
branch
from
a781daa to
53152ca
Compare
Co-authored-by: Cem Aksoylar <[email protected]>
This was referenced Sep 30, 2024
rafaelromao
pushed a commit
to rafaelromao/zmk
that referenced
this pull request
Oct 8, 2024
* docs: Streamlined the new shield guide --------- Co-authored-by: Cem Aksoylar <[email protected]>
lammai
pushed a commit
to lammai/zmk
that referenced
this pull request
Oct 27, 2024
* docs: Streamlined the new shield guide --------- Co-authored-by: Cem Aksoylar <[email protected]>
EnotionZ
pushed a commit
to EnotionZ/zmk
that referenced
this pull request
Nov 6, 2024
* docs: Streamlined the new shield guide --------- Co-authored-by: Cem Aksoylar <[email protected]>
earwin
pushed a commit
to earwin/zmk
that referenced
this pull request
Nov 13, 2024
* docs: Streamlined the new shield guide --------- Co-authored-by: Cem Aksoylar <[email protected]>
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.
This PR builds on #2510 in an attempt to streamline our new shield guide somewhat. I do see some further improvements that can be made, but I think this version reads nicer and eases future improvements. In particular, the future improvements I'd like to see are:
I think the above steps are likely required in order to be able to write a nice "New Keyboard Board" guide in the future.