feat(docs): Generate new shield interconnect docs. #1607
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
petejohanson
added
documentation
petejohanson
force-pushed
the
docs/interconnect-new-shield-generated
branch
2 times, most recently
from
2d05215
to
e183987
Compare
|
Deploy preview page with the new implementation: https://deploy-preview-1607--zmk.netlify.app/docs/development/new-shield#shield-overlays |
caksoylar
approved these changes
Dec 23, 2022
There was a problem hiding this comment.
Looks good to me in general, I had a clarification question and a few subjective wording improvements.
Also it looks like the old blackpill and pro micro pinout assets can be removed; I found only one other reference to them:
diff --git a/docs/docs/assets/blackpill/blackpill-pins-labelled.png b/docs/docs/assets/blackpill/blackpill-pins-labelled.png
deleted file mode 100644
index 3f15c620..00000000
Binary files a/docs/docs/assets/blackpill/blackpill-pins-labelled.png and /dev/null differ
diff --git a/docs/docs/assets/pro-micro/pro-micro-pins-labelled.jpg b/docs/docs/assets/pro-micro/pro-micro-pins-labelled.jpg
deleted file mode 100644
index 88161e39..00000000
Binary files a/docs/docs/assets/pro-micro/pro-micro-pins-labelled.jpg and /dev/null differ
diff --git a/docs/docs/development/boards-shields-keymaps.md b/docs/docs/development/boards-shields-keymaps.md
index 4444537e..4644ee79 100644
--- a/docs/docs/development/boards-shields-keymaps.md
+++ b/docs/docs/development/boards-shields-keymaps.md
@@ -34,7 +34,7 @@ in the `app/boards/${arch}/${board_name}` directory, e.g. `app/boards/arm/planck
## Pro Micro Compatible Keyboard
-
+
For keyboards that require a (usually Pro Micro compatible) add-on board to operate, the ZMK integration pieces are places
in the _shield_ definition for that keyboard, allowing users to
petejohanson
force-pushed
the
docs/interconnect-new-shield-generated
branch
3 times, most recently
from
3f3f732
to
865d7c8
Compare
* Add to metadata schema for interconnects. * New conventional location for pinout diagrams/pics. * New component to generate the tabs for the new shield doc section on interconnects. * Add XIAO and arduino uno pinout diagram. Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
petejohanson
force-pushed
the
docs/interconnect-new-shield-generated
branch
from
865d7c8
to
b4715db
Compare
caksoylar
approved these changes
Dec 23, 2022
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.
doc section on interconnects.