feat(docs) Adding a hardware issues page under troubleshooting #2360
Conversation
caksoylar
added
enhancement
Nick-Munnich
force-pushed
the
hardware-issues
branch
from
1a8de49
to
8899edb
Compare
Nick-Munnich
changed the title
|
Did a big overhaul of this, updated the title and description accordingly. |
|
Oh, I think this needs to be rebased to fix the broken link in build. |
Nick-Munnich
force-pushed
the
hardware-issues
branch
from
ab77156
to
d6f34bb
Compare
Co-authored-by: Anant Thazhemadam <[email protected]>
| This page contains _general advice_ for troubleshooting hardware issues. ZMK **does not** provide any sort of hardware support. If the below points are unable to resolve your problem, contact your vendor/manufacturer for assistance. | ||
|
|
||
| You can contact ZMK for assistance with resolving firmware issues _after_ resolving your hardware issues, if your vendor/manufacturer is unable to provide said support. |
There was a problem hiding this comment.
| This page contains _general advice_ for troubleshooting hardware issues. ZMK **does not** provide any sort of hardware support. If the below points are unable to resolve your problem, contact your vendor/manufacturer for assistance. | |
| You can contact ZMK for assistance with resolving firmware issues _after_ resolving your hardware issues, if your vendor/manufacturer is unable to provide said support. | |
| This page contains _general advice_ for troubleshooting hardware issues. Your first point of call should always be the vendor/manufacturer of the product. If you bought it, your purchase may include access to dedicated support channels and a warranty. | |
| ZMK is software—not hardware—and while its community is often happy to help, ZMK collaborators cannot provide official support for hardware they did not create. |
Probably too region-specific to link to this or this, but if you've got any better ideas to remind end-users that they may have some sort of recourse before trying to fix it themselves—especially if something doesn't work OOTB—that'd probably be a good thing to try and get across here.
Maybe :::danger would be appropriate here; see later comments regarding the removal of a different infobox.
There was a problem hiding this comment.
Rephrasing this is a good idea, and reminding about warranty/support is also good. I'm not sold on remarking that the community is happy to help - part of my motivation for writing this page was out of frustration with the aliexpress vendors essentially using the ZMK discord as free tech support, though others may see it differently...
There was a problem hiding this comment.
Maybe a slight wording change like "the community might be able to provide help"? Less committal but also reflecting the reality.
There was a problem hiding this comment.
I'm not sold on remarking that the community is happy to help
I did qualify that happy with an "often", not "always", but very fair; feel free to rethink. I was mostly concerned about how the original wording was interpretable as obliging ZMK collaborators to help with firmware...
There was a problem hiding this comment.
Tried rewriting - let me know what you think.
Co-authored-by: Less/Rikki <[email protected]>
This PR adds a "hardware issues" page under troubleshooting. It discusses:
In the process, there are also two new shields to help with troubleshooting:
tester_pro_microandtester_xiao. This partially resolves #2410, though I would really like a more general solution eventually.