summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorinnovaker <66737976+innovaker@users.noreply.github.com>2020-06-13 19:49:28 +0100
committerinnovaker <66737976+innovaker@users.noreply.github.com>2020-06-13 20:02:24 +0100
commit726b40cfa25d98a82e0eea99f7a5c03db327f6b6 (patch)
treeb9f885b0481fdc7870594905550398def9250369
parentc14beb7ee7b38d95e48ef1506180f4813a2354ed (diff)
docs: faq: Add preface links to "Why boards and shields?" [#22 CR, #11]
-rw-r--r--docs/docs/faq.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/docs/faq.md b/docs/docs/faq.md
index 5b3c4b2..d1896fe 100644
--- a/docs/docs/faq.md
+++ b/docs/docs/faq.md
@@ -60,6 +60,10 @@ In ZMK, a *shield* is a *PCB* or *hardwired set of components* that when combine
### Why *boards* and *shields*? Why not just “keyboard”?
+If you haven't already done so, please read these FAQs first:
+- [What is a “board”?](#what-is-a-board)
+- [What is a "shield"?](#what-is-a-shield)
+
When a keyboard accepts a small “PCB MCU module” (e.g. *Arduino Pro Micro*) for its “brains”, then it's important to conceptually separate the hardware into a *board* PCB and a *shield* PCB.
The *shield* is a brainless shell containing all the keys, RGB LEDs, encoders etc. It maps all of these features to a standard pin footprint, such as the Pro Micro pinout.