-
-
Notifications
You must be signed in to change notification settings - Fork 38.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update hand wire guide #7044
Update hand wire guide #7044
Conversation
Added some images and put the "Matrix" section in a hidden <details> section
removed .jpg from .gitignore
Incomplete, but started making the guide more general. Will continue to add images (in imgur as requested)
I think a lot of these changes look good, but as someone who just went through this, I feel like some reference to the split keyboard feature should be mentioned. There are a couple of gotchas when hand-wiring a split keyboard that may not be as much of a problem when using a pcb based kit. The main one that I have come across is when using i2c for connecting the halves, it will cause issues if the resistors are not present(i.e. in the other half, not connected). It may make more sense to have that in the split keyboard docs, but if so, then maybe just a link to there. Also, it may be nice to link to additional features as a next step, like RGB, Oled, etc. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks much better!!
Thanks! |
* Reorganised Hand Wire Guide Added some images and put the "Matrix" section in a hidden <details> section * Actually adding images this time removed .jpg from .gitignore * Hand wire guide updated Incomplete, but started making the guide more general. Will continue to add images (in imgur as requested) * Removed some more images from gitignore * testing image changes (temporary) * Update hand_wire.md * added techniques table * Tweaking the table * Finished soldering guide * Fixed some links, change image scaling * More of the same * resizing images * updated images * Update hand_wire.md * Resizing images * Update hand_wire.md * Update hand_wire.md * Create ribbon_cable.jpg * Minor updates to links * Updated firmware and flashing guidelines * Updated images to imgur links and re-added images to gitignore * Implemented requested changes. Improved wording * Added handwire helpers info and split KB info * Update hand_wire.md * Removed "the" from "the QMK toolbox" * Fixed handwire helper table and image size * Fixed a heading
* Reorganised Hand Wire Guide Added some images and put the "Matrix" section in a hidden <details> section * Actually adding images this time removed .jpg from .gitignore * Hand wire guide updated Incomplete, but started making the guide more general. Will continue to add images (in imgur as requested) * Removed some more images from gitignore * testing image changes (temporary) * Update hand_wire.md * added techniques table * Tweaking the table * Finished soldering guide * Fixed some links, change image scaling * More of the same * resizing images * updated images * Update hand_wire.md * Resizing images * Update hand_wire.md * Update hand_wire.md * Create ribbon_cable.jpg * Minor updates to links * Updated firmware and flashing guidelines * Updated images to imgur links and re-added images to gitignore * Implemented requested changes. Improved wording * Added handwire helpers info and split KB info * Update hand_wire.md * Removed "the" from "the QMK toolbox" * Fixed handwire helper table and image size * Fixed a heading
* Reorganised Hand Wire Guide Added some images and put the "Matrix" section in a hidden <details> section * Actually adding images this time removed .jpg from .gitignore * Hand wire guide updated Incomplete, but started making the guide more general. Will continue to add images (in imgur as requested) * Removed some more images from gitignore * testing image changes (temporary) * Update hand_wire.md * added techniques table * Tweaking the table * Finished soldering guide * Fixed some links, change image scaling * More of the same * resizing images * updated images * Update hand_wire.md * Resizing images * Update hand_wire.md * Update hand_wire.md * Create ribbon_cable.jpg * Minor updates to links * Updated firmware and flashing guidelines * Updated images to imgur links and re-added images to gitignore * Implemented requested changes. Improved wording * Added handwire helpers info and split KB info * Update hand_wire.md * Removed "the" from "the QMK toolbox" * Fixed handwire helper table and image size * Fixed a heading
First round of changes to the hand wire guide
Changed the physical hand wiring section to be less prescriptive and hopefully show that there are multiple ways of skinning a cat (with examples).
Tried not to remove the content of the previous version but re-wrote and put some sections in collapsible
<details>
tags.Added images (originally into the project but as per discussion in #1686 put them in an imgur album and linked)
(As an aside I think their should be a separate QMK documentation repo)
Still want to make some changes to the but figured it was in a good enough state now to merge.
Types of Changes
Issues Fixed or Closed by This PR
Checklist