Skip to content

Commit

Permalink
fix(docs): minor corrections and fix typo (zmkfirmware#2443)
Browse files Browse the repository at this point in the history
* docs(faq): minor corrections

* docs: fix typo - `s/Alterative/Alternative`

* docs(faq): use Lily58 as an example instead of Corne with revision

Co-authored-by: Nicolas Munnich <[email protected]>

---------

Co-authored-by: Nicolas Munnich <[email protected]>
  • Loading branch information
thazhemadam and Nick-Munnich authored Aug 27, 2024
1 parent b866ec0 commit 6946ca8
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ For keyboards, this is one of two options:

### What is a “shield”?

In ZMK, a _shield_ is a _PCB_ or _hardwired set of components_ that when combined with a MCU only [board](#what-is-a-board) like the Proton-C or nice!nano, results in a complete usable keyboard. Examples would be keyboard PCBs like the Kyria or Corne. The _shield_ is usually the big PCB containing all the keys.
In ZMK, a _shield_ is a _PCB_ or _hardwired set of components_ that when combined with an MCU-only [board](#what-is-a-board), like the Proton-C or nice!nano, results in a complete usable keyboard. Examples would be keyboard PCBs like the Kyria or Lily58. The _shield_ is usually the big PCB containing all the keys.

### Why _boards_ and _shields_? Why not just “keyboard”?

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/features/modules.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ When [using GitHub Actions to build ZMK](../user-setup.mdx), once you have obtai
defaultValue="zmk"
values={[
{label: 'Default', value: 'zmk'},
{label: 'Alterative', value: 'alt'},
{label: 'Alternative', value: 'alt'},
]}>
<TabItem value="zmk">

Expand Down

0 comments on commit 6946ca8

Please sign in to comment.