docs: Fixed typos in compile-examples and arduino-ci docs.

Signed-off-by: jaenrig-ifx <[email protected]>

Author: jaenrig-ifx

docs/compile-examples/description.rst

@@ -17,7 +17,7 @@ specifications to auto-discover the available boards and examples available in t
 
 The default auto-discovery matrix can be customized to consider exceptions via configuration YAML files.
 
-It also supports the installation of the tools and source dependencies for multiple operating systems required to compile the sketches for the selected boards.
+It also supports the installation of the tools and source dependencies for multiple operating systems, which are necessary for compiling the sketches for the selected boards.
 
 Implementation details
 ^^^^^^^^^^^^^^^^^^^^^^

docs/compile-examples/getting-started.rst

@@ -3,16 +3,16 @@
 Getting started
 ----------------
 
-This section will guide your through the steps to setup the compile examples workflow in your repository.
+This section will guide you through the steps to setup the compile examples workflow in your repository.
 
 Prerequisites
 ^^^^^^^^^^^^^^
 
 Before you start, make sure you satisfy the following prerequisites:
 
 - Your Arduino asset (library or core) is hosted in a GitHub repository.
-- GitHub Actions enabled in your repository. Check the `GitHub docs <https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository>`_ to learn how to enable it.
-- If your asset is an Arduino core, first you need to `configure the repository <df>`_ to be able generate the core package with the ``core-packager.py`` tool. 
+- GitHub Actions is enabled in your repository. Check the `GitHub docs <https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#managing-github-actions-permissions-for-your-repository>`_ to learn how to enable it.
+- If your asset is an Arduino core, first you need to `configure the repository <df>`_ to be able to generate the core package with the ``core-packager.py`` tool. 
 
 Enabling the reusable workflow
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -51,7 +51,7 @@ Now, you can go to the ``Actions`` tab of your repository in GitHub and see the
 
 If your asset is an **Arduino core**, the workflow will compile all the available examples from the built-in libraries against each of the boards in the `board.txt <https://docs.arduino.cc/arduino-cli/platform-specification/#boardstxt>`_ file.
 
-In the case of **Arduino libraries**, the workflow will to compile all the examples available in the ``examples`` directory for the default set of boards defined
+In the case of **Arduino libraries**, the workflow will compile all the examples available in the ``examples`` directory for the default set of boards defined
 in the file: `config/ci-config-matrix-ifx-lib.yml <https://github.com/Infineon/arduino-devops/blob/main/config/ci-config-matrix-ifx-lib.yml>`_.
 
 

docs/scripts/arduino-ci.rst

@@ -23,8 +23,9 @@ Otherwise, you can specify the file by using the flag ``-c``, ``--ci-matrix-yml`
 
     python arduino-devops/arduino-ci.py <command> -c path/to/ci-matrix-config.yml
 
-When calling the tool, it will consider the current path the root path of the Arduino asset.
-Otherwise, you will need to specify the root path of the asset by using the flag ``-r``, ``--root-path`` followed by the path to the root of the asset:
+The script needs to know the root path of the asset to be able to discover the boards and examples.
+Unless specified, the root path will be the current working directory from which the script is executed.
+Otherwise, you will need to specify the root path of the asset by using the flag ``-r``, ``--root-path`` followed by the path to the asset's root directory:
 
 .. code:: bash
 
@@ -42,7 +43,7 @@ config
 Shows and queries the ci configuration matrix. This command is helpful within CI/CD workflows in the creation of parallel jobs 
 for the compilation of the sketches and boards matrix.
 
-It support the following output formats:
+It supports the following output formats:
 
  - JSON (``--json`` or ``--json-pretty``)
  - YAML (``--yaml``) . 
@@ -113,7 +114,7 @@ Or we can compile all the relevant sketches for a given board by using the ``--f
 core-install
 ------------
 
-In case of Arduino libraries, before being able to compile the matrix, you will need to have the package cores of each of the matrix boards installed.
+To compile the matrix for Arduino libraries, you must first install the package cores for each board in the matrix.
 
 The following command will take care of the installation of all the required package cores:
 
@@ -215,7 +216,7 @@ The yaml file uses the following keys:
                 and these particular values are "not discoverable".
 
         The allowed keys are ``fqbn`` and ``sketch``. 
-        The value formats allowed are the same as the root node keys. 
+        The value formats allowed are the same as the root `node <https://yaml.org/spec/1.2.2/#nodes>`_ keys (``fqbn`` and ``sketch`` as primary keys in the YAML file). 
         But in this case, the value can be a list (of scalars) or a scalar.
 
         Example:
@@ -246,12 +247,12 @@ The yaml file uses the following keys:
 
         - Single keys: 
             A dictionary with either ``fqbn`` or ``sketch`` key. The
-            values will them be then (if present) removed from the default matrix key. 
+            values will be (if present) removed from the default matrix key. 
             This is mainly useful when the main matrix is automatically discovered, 
-            and a one particular value is not (momentarily?) compatible for some reason.
+            and a particular value is not compatible for some reason.
 
         The allowed keys are ``fqbn`` and ``sketch``. 
-        The value formats allowed are the same as the root node keys. 
+        The value formats allowed are the same as the root `node <https://yaml.org/spec/1.2.2/#nodes>`_ keys (``fqbn`` and ``sketch`` as primary keys in the YAML file). 
         But in this case, the value can be a list (of scalars) or a scalar.
 
         Example: