From a284989fa0e44e2ce1e2bd3b78a6a06b2f4cd848 Mon Sep 17 00:00:00 2001 From: pelikhan Date: Mon, 6 Nov 2023 13:16:11 -0800 Subject: [PATCH] missing newlines in docs --- compiler/src/board.ts | 4 ++-- website/docs/devices/esp32/adafruit-feather-esp32-s2.mdx | 2 ++ website/docs/devices/esp32/adafruit-qt-py-c3.mdx | 2 ++ website/docs/devices/esp32/esp32-bare.mdx | 2 ++ website/docs/devices/esp32/esp32-c3fh4-rgb.mdx | 2 ++ website/docs/devices/esp32/esp32-devkit-c.mdx | 2 ++ website/docs/devices/esp32/esp32c3-bare.mdx | 2 ++ website/docs/devices/esp32/esp32c3-rust-devkit.mdx | 2 ++ website/docs/devices/esp32/esp32c3-supermini.mdx | 2 ++ website/docs/devices/esp32/esp32s2-bare.mdx | 2 ++ website/docs/devices/esp32/esp32s3-bare.mdx | 2 ++ website/docs/devices/esp32/esp32s3-devkit-m.mdx | 2 ++ website/docs/devices/esp32/feather-s2.mdx | 2 ++ website/docs/devices/esp32/kittenbot-grapebit-esp32c3.mdx | 2 ++ website/docs/devices/esp32/msr207-v42.mdx | 2 ++ website/docs/devices/esp32/msr207-v43.mdx | 2 ++ website/docs/devices/esp32/msr48.mdx | 2 ++ website/docs/devices/esp32/seeed-xiao-esp32c3-msr218.mdx | 2 ++ website/docs/devices/esp32/seeed-xiao-esp32c3.mdx | 2 ++ website/docs/devices/rp2040/kittenbot-nanoscript.mdx | 2 ++ website/docs/devices/rp2040/msr124.mdx | 2 ++ website/docs/devices/rp2040/msr59.mdx | 2 ++ website/docs/devices/rp2040/pico-w.mdx | 2 ++ website/docs/devices/rp2040/pico.mdx | 2 ++ 24 files changed, 48 insertions(+), 2 deletions(-) diff --git a/compiler/src/board.ts b/compiler/src/board.ts index d070c49d0c..081b460035 100644 --- a/compiler/src/board.ts +++ b/compiler/src/board.ts @@ -150,9 +150,9 @@ description: ${devName} : undefined, `\n## Features\n`, ...info.features.map(f => `- ${f}`), - `{@import optional ./${fdevId}-features.mdp}\n`, + `\n{@import optional ./${fdevId}-features.mdp}\n`, ...info.services.map(f => `- Service: ${f}`), - `{@import optional ./${fdevId}-services.mdp}\n`, + `\n{@import optional ./${fdevId}-services.mdp}\n`, !boardJson.i2c && ` :::caution diff --git a/website/docs/devices/esp32/adafruit-feather-esp32-s2.mdx b/website/docs/devices/esp32/adafruit-feather-esp32-s2.mdx index 550d12dff7..4cf3151a31 100644 --- a/website/docs/devices/esp32/adafruit-feather-esp32-s2.mdx +++ b/website/docs/devices/esp32/adafruit-feather-esp32-s2.mdx @@ -12,8 +12,10 @@ A S2 Feather from Adafruit. (untested) - I2C on SDA/SCL using Qwiic connector - WS2812B RGB LED on pin 33 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin 43 at 115200 8N1 + {@import optional ./adafruit-feather-esp32-s2-features.mdp} + {@import optional ./adafruit-feather-esp32-s2-services.mdp} diff --git a/website/docs/devices/esp32/adafruit-qt-py-c3.mdx b/website/docs/devices/esp32/adafruit-qt-py-c3.mdx index 0c74afc568..b9a8718cf2 100644 --- a/website/docs/devices/esp32/adafruit-qt-py-c3.mdx +++ b/website/docs/devices/esp32/adafruit-qt-py-c3.mdx @@ -14,9 +14,11 @@ A tiny ESP32-C3 board. - I2C on SDA_D4/SCL_D5 using Qwiic connector - WS2812B RGB LED on pin 2 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin TX_D6 at 115200 8N1 + {@import optional ./adafruit-qt-py-c3-features.mdp} - Service: buttonBOOT (button) + {@import optional ./adafruit-qt-py-c3-services.mdp} diff --git a/website/docs/devices/esp32/esp32-bare.mdx b/website/docs/devices/esp32/esp32-bare.mdx index 3e7b76f6c4..2448bb724f 100644 --- a/website/docs/devices/esp32/esp32-bare.mdx +++ b/website/docs/devices/esp32/esp32-bare.mdx @@ -9,8 +9,10 @@ Bare ESP32 without any default functions for pins. ## Features + {@import optional ./esp32-bare-features.mdp} + {@import optional ./esp32-bare-services.mdp} diff --git a/website/docs/devices/esp32/esp32-c3fh4-rgb.mdx b/website/docs/devices/esp32/esp32-c3fh4-rgb.mdx index 68a36a28d9..5d43f18f0d 100644 --- a/website/docs/devices/esp32/esp32-c3fh4-rgb.mdx +++ b/website/docs/devices/esp32/esp32-c3fh4-rgb.mdx @@ -14,9 +14,11 @@ A tiny ESP32-C3 board with 5x5 LED array. - I2C on 0/1 using Qwiic connector - LED on pin 10 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin 21 at 115200 8N1 + {@import optional ./esp32-c3fh4-rgb-features.mdp} - Service: buttonBOOT (button) + {@import optional ./esp32-c3fh4-rgb-services.mdp} diff --git a/website/docs/devices/esp32/esp32-devkit-c.mdx b/website/docs/devices/esp32/esp32-devkit-c.mdx index 5d6a610be1..9abde1f5cc 100644 --- a/website/docs/devices/esp32/esp32-devkit-c.mdx +++ b/website/docs/devices/esp32/esp32-devkit-c.mdx @@ -12,9 +12,11 @@ There are currently issues with serial chip on these, best avoid. ESP32-DevKitC ## Features - LED on pin 2 (use [setStatusLight](/developer/status-light) to control) + {@import optional ./esp32-devkit-c-features.mdp} - Service: buttonIO0 (button) + {@import optional ./esp32-devkit-c-services.mdp} diff --git a/website/docs/devices/esp32/esp32c3-bare.mdx b/website/docs/devices/esp32/esp32c3-bare.mdx index 01095a9431..f50524406f 100644 --- a/website/docs/devices/esp32/esp32c3-bare.mdx +++ b/website/docs/devices/esp32/esp32c3-bare.mdx @@ -10,9 +10,11 @@ A bare ESP32-C3 board without any pin functions. ## Features - Serial logging on pin P21 at 115200 8N1 + {@import optional ./esp32c3-bare-features.mdp} - Service: buttonBOOT (button) + {@import optional ./esp32c3-bare-services.mdp} diff --git a/website/docs/devices/esp32/esp32c3-rust-devkit.mdx b/website/docs/devices/esp32/esp32c3-rust-devkit.mdx index b576170fed..19deb9df34 100644 --- a/website/docs/devices/esp32/esp32c3-rust-devkit.mdx +++ b/website/docs/devices/esp32/esp32c3-rust-devkit.mdx @@ -14,9 +14,11 @@ A ESP32-C3 dev-board from Espressif with IMU and Temp/Humidity sensor, originall - I2C on 10/8 using Header connector - WS2812B RGB LED on pin 2 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin P21 at 115200 8N1 + {@import optional ./esp32c3-rust-devkit-features.mdp} - Service: buttonBOOT (button) + {@import optional ./esp32c3-rust-devkit-services.mdp} diff --git a/website/docs/devices/esp32/esp32c3-supermini.mdx b/website/docs/devices/esp32/esp32c3-supermini.mdx index 21d60b3391..97457d66be 100644 --- a/website/docs/devices/esp32/esp32c3-supermini.mdx +++ b/website/docs/devices/esp32/esp32c3-supermini.mdx @@ -12,9 +12,11 @@ A super tiny ESP32-C3 board. - I2C on 6/7 - LED on pin 8 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin 21 at 115200 8N1 + {@import optional ./esp32c3-supermini-features.mdp} - Service: buttonBOOT (button) + {@import optional ./esp32c3-supermini-services.mdp} diff --git a/website/docs/devices/esp32/esp32s2-bare.mdx b/website/docs/devices/esp32/esp32s2-bare.mdx index 5ba036c4f4..f8a453a4e9 100644 --- a/website/docs/devices/esp32/esp32s2-bare.mdx +++ b/website/docs/devices/esp32/esp32s2-bare.mdx @@ -10,8 +10,10 @@ A bare ESP32-S2 board without any pin functions. ## Features - Serial logging on pin P43 at 115200 8N1 + {@import optional ./esp32s2-bare-features.mdp} + {@import optional ./esp32s2-bare-services.mdp} diff --git a/website/docs/devices/esp32/esp32s3-bare.mdx b/website/docs/devices/esp32/esp32s3-bare.mdx index aa7a912acf..f34dbff445 100644 --- a/website/docs/devices/esp32/esp32s3-bare.mdx +++ b/website/docs/devices/esp32/esp32s3-bare.mdx @@ -10,8 +10,10 @@ A bare ESP32-S3 board without any pin functions. ## Features - Serial logging on pin P43 at 115200 8N1 + {@import optional ./esp32s3-bare-features.mdp} + {@import optional ./esp32s3-bare-services.mdp} diff --git a/website/docs/devices/esp32/esp32s3-devkit-m.mdx b/website/docs/devices/esp32/esp32s3-devkit-m.mdx index bd1dba8912..a1a4164cf4 100644 --- a/website/docs/devices/esp32/esp32s3-devkit-m.mdx +++ b/website/docs/devices/esp32/esp32s3-devkit-m.mdx @@ -13,8 +13,10 @@ ESP32-S3 DevKitM development board. Should also work for DevKitC. - WS2812B RGB LED on pin P48 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin P43 at 115200 8N1 + {@import optional ./esp32s3-devkit-m-features.mdp} + {@import optional ./esp32s3-devkit-m-services.mdp} diff --git a/website/docs/devices/esp32/feather-s2.mdx b/website/docs/devices/esp32/feather-s2.mdx index 4f609fff58..428d48f963 100644 --- a/website/docs/devices/esp32/feather-s2.mdx +++ b/website/docs/devices/esp32/feather-s2.mdx @@ -14,10 +14,12 @@ ESP32-S2 based development board in a Feather format. - I2C on SDA/SCL using Qwiic connector - LED on pin 40 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin TX_D1 at 115200 8N1 + {@import optional ./feather-s2-features.mdp} - Service: buttonBOOT (button) - Service: ambientLight (analog:lightLevel) + {@import optional ./feather-s2-services.mdp} diff --git a/website/docs/devices/esp32/kittenbot-grapebit-esp32c3.mdx b/website/docs/devices/esp32/kittenbot-grapebit-esp32c3.mdx index 2520d75f32..43c24d6cea 100644 --- a/website/docs/devices/esp32/kittenbot-grapebit-esp32c3.mdx +++ b/website/docs/devices/esp32/kittenbot-grapebit-esp32c3.mdx @@ -14,6 +14,7 @@ A round board packed with IMU, buzzer, motor control, 4 RGB LEDs, and Jacdac. - Jacdac on pin 5 using Jacdac connector - I2C on 6/7 - WS2812B RGB LED on pin 10 (use [setStatusLight](/developer/status-light) to control) + {@import optional ./kittenbot-grapebit-esp32c3-features.mdp} - Service: buttonA (button) @@ -21,6 +22,7 @@ A round board packed with IMU, buzzer, motor control, 4 RGB LEDs, and Jacdac. - Service: music (buzzer) - Service: M1 (motor) - Service: M2 (motor) + {@import optional ./kittenbot-grapebit-esp32c3-services.mdp} diff --git a/website/docs/devices/esp32/msr207-v42.mdx b/website/docs/devices/esp32/msr207-v42.mdx index e2e6f289f1..53a1878be6 100644 --- a/website/docs/devices/esp32/msr207-v42.mdx +++ b/website/docs/devices/esp32/msr207-v42.mdx @@ -9,9 +9,11 @@ description: MSR JM Brain S2-mini 207 v4.2 - Jacdac on pin 17 using Jacdac connector - RGB LED on pins 8, 7, 6 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin 43 at 115200 8N1 + {@import optional ./msr207-v42-features.mdp} - Service: power (auto-start) + {@import optional ./msr207-v42-services.mdp} diff --git a/website/docs/devices/esp32/msr207-v43.mdx b/website/docs/devices/esp32/msr207-v43.mdx index be1ff97200..4c908c0b4c 100644 --- a/website/docs/devices/esp32/msr207-v43.mdx +++ b/website/docs/devices/esp32/msr207-v43.mdx @@ -9,9 +9,11 @@ description: MSR JM Brain S2-mini 207 v4.3 - Jacdac on pin 17 using Jacdac connector - RGB LED on pins 8, 7, 6 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin 43 at 115200 8N1 + {@import optional ./msr207-v43-features.mdp} - Service: power (auto-start) + {@import optional ./msr207-v43-services.mdp} diff --git a/website/docs/devices/esp32/msr48.mdx b/website/docs/devices/esp32/msr48.mdx index 89e19fe59b..d31b8844ec 100644 --- a/website/docs/devices/esp32/msr48.mdx +++ b/website/docs/devices/esp32/msr48.mdx @@ -12,9 +12,11 @@ description: MSR JacdacIoT 48 v0.2 - I2C on 9/10 using Qwiic connector - RGB LED on pins 8, 7, 6 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin 43 at 115200 8N1 + {@import optional ./msr48-features.mdp} - Service: power (auto-start) + {@import optional ./msr48-services.mdp} diff --git a/website/docs/devices/esp32/seeed-xiao-esp32c3-msr218.mdx b/website/docs/devices/esp32/seeed-xiao-esp32c3-msr218.mdx index 8cc1f8986e..3094d2547b 100644 --- a/website/docs/devices/esp32/seeed-xiao-esp32c3-msr218.mdx +++ b/website/docs/devices/esp32/seeed-xiao-esp32c3-msr218.mdx @@ -15,8 +15,10 @@ A tiny ESP32-C3 board mounted on base with Jacdac, Qwiic and Grove connectors. - I2C on SDA/SCL using Qwiic connector - WS2812B RGB LED on pin LED (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin TX at 115200 8N1 + {@import optional ./seeed-xiao-esp32c3-msr218-features.mdp} + {@import optional ./seeed-xiao-esp32c3-msr218-services.mdp} diff --git a/website/docs/devices/esp32/seeed-xiao-esp32c3.mdx b/website/docs/devices/esp32/seeed-xiao-esp32c3.mdx index e0a1ff95da..61a9ab61ec 100644 --- a/website/docs/devices/esp32/seeed-xiao-esp32c3.mdx +++ b/website/docs/devices/esp32/seeed-xiao-esp32c3.mdx @@ -12,9 +12,11 @@ A tiny ESP32-C3 board. ## Features - Serial logging on pin TX_D6 at 115200 8N1 + {@import optional ./seeed-xiao-esp32c3-features.mdp} - Service: buttonBOOT (button) + {@import optional ./seeed-xiao-esp32c3-services.mdp} diff --git a/website/docs/devices/rp2040/kittenbot-nanoscript.mdx b/website/docs/devices/rp2040/kittenbot-nanoscript.mdx index 642993cff7..fc6a88ea1b 100644 --- a/website/docs/devices/rp2040/kittenbot-nanoscript.mdx +++ b/website/docs/devices/rp2040/kittenbot-nanoscript.mdx @@ -14,9 +14,11 @@ A RP2040 board featuring a Jacdac connector, compatible with SMT-mounting. - Jacdac on pin 9 using Jacdac connector - RGB LED on pins 16, 14, 15 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin 0 at 115200 8N1 + {@import optional ./kittenbot-nanoscript-features.mdp} - Service: power (auto-start) + {@import optional ./kittenbot-nanoscript-services.mdp} diff --git a/website/docs/devices/rp2040/msr124.mdx b/website/docs/devices/rp2040/msr124.mdx index 10b49f3d12..d206f096a8 100644 --- a/website/docs/devices/rp2040/msr124.mdx +++ b/website/docs/devices/rp2040/msr124.mdx @@ -12,9 +12,11 @@ Prototype board - Jacdac on pin 9 using Jacdac connector - RGB LED on pins 16, 14, 15 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin 0 at 115200 8N1 + {@import optional ./msr124-features.mdp} - Service: power (auto-start) + {@import optional ./msr124-services.mdp} diff --git a/website/docs/devices/rp2040/msr59.mdx b/website/docs/devices/rp2040/msr59.mdx index e30d4cbdd0..e36cadf05f 100644 --- a/website/docs/devices/rp2040/msr59.mdx +++ b/website/docs/devices/rp2040/msr59.mdx @@ -14,9 +14,11 @@ Prototype board - Jacdac on pin 9 using Jacdac connector - RGB LED on pins 11, 13, 15 (use [setStatusLight](/developer/status-light) to control) - Serial logging on pin 2 at 115200 8N1 + {@import optional ./msr59-features.mdp} - Service: power (auto-start) + {@import optional ./msr59-services.mdp} diff --git a/website/docs/devices/rp2040/pico-w.mdx b/website/docs/devices/rp2040/pico-w.mdx index 06464524a8..9d118fa11c 100644 --- a/website/docs/devices/rp2040/pico-w.mdx +++ b/website/docs/devices/rp2040/pico-w.mdx @@ -12,8 +12,10 @@ RP2040 board from Raspberry Pi with a WiFi chip. ## Features - custom LED (use [setStatusLight](/developer/status-light) to control) + {@import optional ./pico-w-features.mdp} + {@import optional ./pico-w-services.mdp} diff --git a/website/docs/devices/rp2040/pico.mdx b/website/docs/devices/rp2040/pico.mdx index 7c39231b9e..220722b7a2 100644 --- a/website/docs/devices/rp2040/pico.mdx +++ b/website/docs/devices/rp2040/pico.mdx @@ -12,8 +12,10 @@ RP2040 board from Raspberry Pi. ## Features - custom LED (use [setStatusLight](/developer/status-light) to control) + {@import optional ./pico-features.mdp} + {@import optional ./pico-services.mdp}