pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix(docs): Clear up ambiguity on supported hardware page (#1200)

Browse source
This commit is contained in:
rhhub 2022-03-30 00:51:12 -07:00 committed by GitHub
parent ed41d42874
commit b79b6363a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/src/components/hardware-list.tsx
View file

@ -70,7 +70,7 @@ function mapInterconnect({
return ( return (
<div key={interconnect.id}> <div key={interconnect.id}>
<h4>{interconnect.name} Keyboards</h4> <h4>{interconnect.name} Interconnect</h4>
{interconnect.description && <p>{interconnect.description}</p>} {interconnect.description && <p>{interconnect.description}</p>}
<h5>Boards</h5> <h5>Boards</h5>
<ul> <ul>
@ -148,7 +148,7 @@ function HardwareList({ items }: HardwareListProps) {
return ( return (
<> <>
<h2>Keyboards</h2> <h2>Keyboards</h2>
<h3>Onboard Controller Boards</h3> <h3>Onboard Controller Keyboards</h3>
<p> <p>
Keyboards with onboard controllers are single PCBs that contain all the Keyboards with onboard controllers are single PCBs that contain all the
components of a keyboard, including the controller chip, switch components of a keyboard, including the controller chip, switch
@ -161,12 +161,13 @@ function HardwareList({ items }: HardwareListProps) {
<HardwareLineItem key={s.id} item={s} /> <HardwareLineItem key={s.id} item={s} />
))} ))}
</ul> </ul>
<h3>Composite Boards</h3> <h3>Composite Keyboards</h3>
<p> <p>
Composite keyboards are composed of two main PCBs: a small controller Composite keyboards are composed of two main PCBs: a small controller
board with exposed pads, and a larger keyboard PCB (a shield, in ZMK board with exposed pads, and a larger keyboard PCB (a shield, in ZMK
lingo) with switch footprints and location a where the controller is lingo) with switch footprints and a location where the controller is
added. added. This location is called an interconnect. Multiple interconnects
can be found below.
</p> </p>
{Object.values(grouped.interconnects).map(mapInterconnect)} {Object.values(grouped.interconnects).map(mapInterconnect)}
</> </>