diff --git a/docs/buildprocess.md b/docs/buildprocess.md index 5b5aa3bc..034b922a 100644 --- a/docs/buildprocess.md +++ b/docs/buildprocess.md @@ -1,10 +1,10 @@ # Build Process -The build process is controlled by [platformio.ini](https://github.com/theelims/ESP32-sveltekit/platformio.ini) and automates the build of the front end website with Vite as well as the binary compilation for the ESP32 firmware. Whenever PlatformIO is triggered with the `upload` command this process will call the python script [build_interface.py](https://github.com/theelims/ESP32-sveltekit/scripts/build_interface.py) to action. It will start the Vite build and gzip the resulting files either to the `data/` directory or embed them into a header file. If necessary a file system image for the flash is created and upload to the ESP32 prior to compiling the firmware binary. +The build process is controlled by [platformio.ini](https://github.com/theelims/ESP32-sveltekit/platformio.ini) and automates the build of the front end website with Vite as well as the binary compilation for the ESP32 firmware. Whenever PlatformIO is triggered with the `upload` command this process will call the python script [build_interface.py](https://github.com/theelims/ESP32-sveltekit/scripts/build_interface.py) to action. It will start the Vite build and gzip the resulting files either to the `data/` directory or embed them into a header file. If necessary a file system image for the flash is created for the default build environment and upload to the ESP32 prior to compiling the firmware binary. ## Serving from Flash or PROGMEM -The front end website can be served either from the SPIFFS partition of the flash, or embedded into the firmware binary from PROGMEM (default). Later has the advantage that only one binary needs to be distributed easing the OTA process. Further more this is desirable if you like to preserve the settings stored in the SPIFFS partition, or have other files there that need to survive a firmware update. To serve from the SPIFFS partition instead please uncomment the following build flag: +The front end website can be served either from the SPIFFS partition of the flash, or embedded into the firmware binary from PROGMEM (default). Later has the advantage that only one binary needs to be distributed easing the OTA process. Further more this is desirable if you like to preserve the settings stored in the SPIFFS partition, or have other files there that need to survive a firmware update. To serve from the SPIFFS partition instead please comment the following build flag out: ```ini build_flags = diff --git a/docs/components.md b/docs/components.md index 9475bd07..b8390833 100644 --- a/docs/components.md +++ b/docs/components.md @@ -57,11 +57,11 @@ Just use and style as you please. It doesn't have any slots or events. ``` -Two exports control the behavior of the component. `rssi_dbm` accepts a negative number of the rawa RSSI in dBm and is used to determine how many circles of reception should be shown. An optional boolean `showDBm` (defaults to `false`) shows the indicator badge with the dBm value. +Two exports control the behavior of the component. `rssi_dbm` accepts a negative number of the raw RSSI in dBm and is used to determine how many circles of reception should be shown. An optional boolean `showDBm` (defaults to `false`) shows the indicator badge with the dBm value. ## Settings Card -A Settings Card is in many ways similar to a [collapsible](#collapsible). However, it is styled and is the main element of many settings menus. It also accepts an icon in a dedicate slot and unlike collapsibles has no events. +A Settings Card is in many ways similar to a [collapsible](#collapsible). However, it is styled and is the main element of many settings menus. It also accepts an icon in a dedicate slot and unlike collapsible has no events. ```ts import SettingsCard from "$lib/components/SettingsCard.svelte"; diff --git a/docs/sveltekit.md b/docs/sveltekit.md index b1d69890..70fc7dda 100644 --- a/docs/sveltekit.md +++ b/docs/sveltekit.md @@ -71,4 +71,4 @@ The overall theme of the front end is defined by [DaisyUI](https://daisyui.com/d #### Opinionated use of Shadows -The front end makes some use of colored shadows with the `shadow-primary` and `shadow-secondary` DaisyUI classes. Just use the search and replace function to change this to a more neutral look, if you find teh color too much. +The front end makes some use of colored shadows with the `shadow-primary` and `shadow-secondary` DaisyUI classes. Just use the search and replace function to change this to a more neutral look, if you find the color too much.