From 726b40cfa25d98a82e0eea99f7a5c03db327f6b6 Mon Sep 17 00:00:00 2001 From: innovaker <66737976+innovaker@users.noreply.github.com> Date: Sat, 13 Jun 2020 19:49:28 +0100 Subject: [PATCH] docs: faq: Add preface links to "Why boards and shields?" [#22 CR, #11] --- docs/docs/faq.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/faq.md b/docs/docs/faq.md index 5b3c4b2c..d1896fe9 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.