From 5ba7e260f49d7277ade882410e7e97fda6e815d4 Mon Sep 17 00:00:00 2001 From: Genteure Date: Tue, 18 Mar 2025 06:15:57 +0800 Subject: [PATCH] docs: update name of XIAO boards (#2869) --- app/boards/arm/seeeduino_xiao/seeeduino_xiao.zmk.yml | 2 +- app/boards/arm/seeeduino_xiao_ble/seeeduino_xiao_ble.zmk.yml | 2 +- .../arm/seeeduino_xiao_rp2040/seeeduino_xiao_rp2040.zmk.yml | 2 +- app/boards/interconnects/seeed_xiao/seeed_xiao.zmk.yml | 4 ++-- docs/docs/development/usb-logging.mdx | 2 +- docs/docs/troubleshooting/hardware-issues.mdx | 4 ++-- docs/docs/user-setup.mdx | 4 ++-- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/app/boards/arm/seeeduino_xiao/seeeduino_xiao.zmk.yml b/app/boards/arm/seeeduino_xiao/seeeduino_xiao.zmk.yml index 1225fb317..51093b046 100644 --- a/app/boards/arm/seeeduino_xiao/seeeduino_xiao.zmk.yml +++ b/app/boards/arm/seeeduino_xiao/seeeduino_xiao.zmk.yml @@ -1,6 +1,6 @@ file_format: "1" id: seeeduino_xiao -name: Seeeduino XIAO +name: Seeed Studio XIAO SAMD21 type: board arch: arm outputs: diff --git a/app/boards/arm/seeeduino_xiao_ble/seeeduino_xiao_ble.zmk.yml b/app/boards/arm/seeeduino_xiao_ble/seeeduino_xiao_ble.zmk.yml index 360bd04b3..55bbe5932 100644 --- a/app/boards/arm/seeeduino_xiao_ble/seeeduino_xiao_ble.zmk.yml +++ b/app/boards/arm/seeeduino_xiao_ble/seeeduino_xiao_ble.zmk.yml @@ -1,6 +1,6 @@ file_format: "1" id: seeeduino_xiao_ble -name: Seeeduino XIAO BLE +name: Seeed Studio XIAO nRF52840 type: board arch: arm outputs: diff --git a/app/boards/arm/seeeduino_xiao_rp2040/seeeduino_xiao_rp2040.zmk.yml b/app/boards/arm/seeeduino_xiao_rp2040/seeeduino_xiao_rp2040.zmk.yml index 77d8d664d..1260a9928 100644 --- a/app/boards/arm/seeeduino_xiao_rp2040/seeeduino_xiao_rp2040.zmk.yml +++ b/app/boards/arm/seeeduino_xiao_rp2040/seeeduino_xiao_rp2040.zmk.yml @@ -1,6 +1,6 @@ file_format: "1" id: seeeduino_xiao_rp2040 -name: Seeeduino XIAO RP2040 +name: Seeed Studio XIAO RP2040 type: board arch: arm outputs: diff --git a/app/boards/interconnects/seeed_xiao/seeed_xiao.zmk.yml b/app/boards/interconnects/seeed_xiao/seeed_xiao.zmk.yml index e9b205072..139cf6253 100644 --- a/app/boards/interconnects/seeed_xiao/seeed_xiao.zmk.yml +++ b/app/boards/interconnects/seeed_xiao/seeed_xiao.zmk.yml @@ -5,9 +5,9 @@ type: interconnect url: https://wiki.seeedstudio.com/Seeeduino-XIAO/ manufacturer: Seeed description: | - The Seeed(uino) XIAO is a popular smaller format micro-controller, that has gained popularity as an alternative + The Seeed Studio XIAO is a popular smaller format micro-controller, that has gained popularity as an alternative to the SparkFun Pro Micro. Since its creation, several pin compatible controllers, such - as the Seeeduino XIAO BLE, Adafruit QT Py and Adafruit QT Py RP2040, have become available. + as the Seeed Studio XIAO nRF52840 (also known as XIAO BLE), Adafruit QT Py and Adafruit QT Py RP2040, have become available. node_labels: gpio: xiao_d i2c: xiao_i2c diff --git a/docs/docs/development/usb-logging.mdx b/docs/docs/development/usb-logging.mdx index 4a9cdba34..45c54ad04 100644 --- a/docs/docs/development/usb-logging.mdx +++ b/docs/docs/development/usb-logging.mdx @@ -95,7 +95,7 @@ From there, you should see the various log messages from ZMK and Zephyr, dependi ## Adding USB Logging to a Board -Standard boards such as the nice!nano and Seeeduino XIAO family have the necessary configuration for logging already added, however if you are developing your own standalone board you may wish to add the ability to use USB logging in the future. +Standard boards such as the nice!nano and Seeed Studio XIAO family have the necessary configuration for logging already added, however if you are developing your own standalone board you may wish to add the ability to use USB logging in the future. To do so, you need to follow the upstream Zephyr [`cdc-acm-console` snippet requirements](https://docs.zephyrproject.org/3.5.0/snippets/cdc-acm-console/README.html#requirements) steps. diff --git a/docs/docs/troubleshooting/hardware-issues.mdx b/docs/docs/troubleshooting/hardware-issues.mdx index 4d35bedc5..9890b6d03 100644 --- a/docs/docs/troubleshooting/hardware-issues.mdx +++ b/docs/docs/troubleshooting/hardware-issues.mdx @@ -95,9 +95,9 @@ include: Save the file, commit the changes and push them to GitHub. Download the new firmware zip file build by the latest GitHub Actions job. In it you will find an additional `tester_xiao` UF2 image file. Flash this file to your board. -The pinout of the seeeduino xiao interconnect is shown below: +The pinout of the Seeed Studio XIAO interconnect is shown below: -![Seeeduino Xiao Interconnect pinout](../assets/interconnects/seeed_xiao/pinout.png) +![Seeed Studio XIAO Interconnect pinout](../assets/interconnects/seeed_xiao/pinout.png) diff --git a/docs/docs/user-setup.mdx b/docs/docs/user-setup.mdx index bcab4bca6..9fd333177 100644 --- a/docs/docs/user-setup.mdx +++ b/docs/docs/user-setup.mdx @@ -124,8 +124,8 @@ When prompted, enter the number for the corresponding MCU board you would like t ``` MCU Board Selection: 1) BlueMicro840 v1 5) nRF52840 M.2 Module 9) QMK Proton-C -2) Mikoto 5.20 6) nRFMicro 1.1 (flipped) 10) Seeeduino XIAO -3) nice!nano v1 7) nRFMicro 1.1/1.2 11) Seeeduino XIAO BLE +2) Mikoto 5.20 6) nRFMicro 1.1 (flipped) 10) Seeed Studio XIAO SAMD21 +3) nice!nano v1 7) nRFMicro 1.1/1.2 11) Seeed Studio XIAO nRF52840 4) nice!nano v2 8) nRFMicro 1.3/1.4 12) Quit Pick an MCU board: ```