From 6f01f6a99e21e5e3a585f1977ef6632d0270fba0 Mon Sep 17 00:00:00 2001 From: Petr Gadorek Date: Wed, 11 Dec 2024 15:26:05 +0100 Subject: [PATCH] minor fixes --- docs/book.toml | 1 + docs/src/after_installing.md | 2 +- docs/src/configuration.md | 4 ++-- docs/src/prerequisites.md | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/book.toml b/docs/book.toml index 768a502..fa7d296 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -18,3 +18,4 @@ smart-punctuation = true git-repository-url="https://github.com/espressif/idf-im-ui.git" copy-theme = true additional-files = ["theme"] +site-url = "https://docs.espressif.com/projects/idf-im-ui/en/latest/" \ No newline at end of file diff --git a/docs/src/after_installing.md b/docs/src/after_installing.md index ec7c012..0ae58d0 100644 --- a/docs/src/after_installing.md +++ b/docs/src/after_installing.md @@ -9,4 +9,4 @@ On Windows, the installer creates an icon on your desktop labeled IDF_PowerShell In the installation directory you selected, there will be a .sh script that, when sourced, activates the ESP-IDF environment in your current shell. It’s important to note that this script should be sourced, not executed directly. If you’ve installed multiple versions of ESP-IDF, there will be a separate script for each version. > **Note** -> The script should be really sourced and not executed +> The script must be sourced and not executed! diff --git a/docs/src/configuration.md b/docs/src/configuration.md index 72a1c0e..32b5617 100644 --- a/docs/src/configuration.md +++ b/docs/src/configuration.md @@ -1,12 +1,12 @@ # Configuration -you can open configuration file and than either proceed with simplified instalation or go trought wizard. +You can open the configuration file and proceed with simplified installation or go through the wizard. ![Instalation setup](./screenshots/instal_setup.png) #### Config File -The installer can use a TOML configuration file. the file can be loaded (or drag&dropped) just before choosing between simplified or wizard installation. +The installer can use a TOML configuration file. the file can be loaded (or draged & dropped) just before choosing between simplified or wizard installation. Here is an example of what a configuration file might look like: diff --git a/docs/src/prerequisites.md b/docs/src/prerequisites.md index 55f7f59..41b07d7 100644 --- a/docs/src/prerequisites.md +++ b/docs/src/prerequisites.md @@ -6,7 +6,7 @@ Below are the minimum requirements for running the ESP-IDF. The Installation Man To get started with ESP-IDF, you need Git, CMake, Ninja, and Python. The ESP-IDF Installation Manager will verify the required prerequisites on your system and install any that are missing. -For more details about ESP-IDF prerequisites, please refer to [the ESP-IDF prerequisites documentation](https://docs.espressif.com/projects/esp-idf/en/v4.2.2/esp32/get-started/windows-setup.html). +For more details about ESP-IDF prerequisites, please refer to [the ESP-IDF documentation](https://docs.espressif.com/projects/esp-idf/en/v4.2.2/esp32/get-started/windows-setup.html). > **Note** > If any of these prerequisites are missing, the installer will prompt you to install them. If you agree, the installer will automatically install and configure everything required to run ESP-IDF.