Skip to content
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

Merged
merged 27 commits into from
Oct 25, 2019
Merged

Update hand wire guide #7044

merged 27 commits into from
Oct 25, 2019

Conversation

Gouty
Copy link
Contributor

@Gouty Gouty commented Oct 15, 2019

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

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@rishka
Copy link
Contributor

rishka commented Oct 16, 2019

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.

docs/hand_wire.md Show resolved Hide resolved
docs/hand_wire.md Outdated Show resolved Hide resolved
docs/hand_wire.md Show resolved Hide resolved
Copy link
Member

@drashna drashna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks much better!!

docs/hand_wire.md Outdated Show resolved Hide resolved
docs/hand_wire.md Outdated Show resolved Hide resolved
docs/hand_wire.md Outdated Show resolved Hide resolved
docs/hand_wire.md Show resolved Hide resolved
docs/hand_wire.md Outdated Show resolved Hide resolved
docs/hand_wire.md Outdated Show resolved Hide resolved
docs/hand_wire.md Outdated Show resolved Hide resolved
docs/hand_wire.md Outdated Show resolved Hide resolved
docs/hand_wire.md Outdated Show resolved Hide resolved
@noroadsleft
Copy link
Member

Thanks!

@noroadsleft noroadsleft merged commit 3fd919c into qmk:master Oct 25, 2019
ripxorip pushed a commit to ripxorip/qmk_firmware that referenced this pull request Dec 3, 2019
* 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
HokieGeek pushed a commit to HokieGeek/qmk_firmware that referenced this pull request Feb 21, 2020
* 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
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants