docs/development_instructions.rst: Minor fixes.

Signed-off-by: Eder Julian <[email protected]>

Author: ederjc

docs/development-instructions.rst

@@ -13,16 +13,16 @@ Development Instructions
 
 .. _env_dev_setup:
 
-Environment setup
+Environment Setup
 ------------------
 
 #. Pre-conditions:
 
    * Install `Arduino IDE (2.0 or higher) <https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-downloading-and-installing/>`_ 
    * Or Install `Arduino CLI (1.0.0 or higher) <https://arduino.github.io/arduino-cli/latest/installation/>`_
-   * Python (you need this for upload/ flash XMC board anyways)
+   * Python
 
-#. Create an ``<SKETCHBOOK>/hardware/arduino-git`` folder. Where ``<SKETCHBOOK>`` is the location of your Arduino sketchbook. The ``<SKETCHBOOK>`` default is OS-dependent:
+#. Create a ``<SKETCHBOOK>/hardware/arduino-git`` folder. Where ``<SKETCHBOOK>`` is the location of your Arduino sketchbook. The ``<SKETCHBOOK>`` default is OS-dependent:
 
    .. tabs::
 
@@ -50,42 +50,42 @@ Environment setup
 
       git clone https://github.com/Infineon/XMC-for-Arduino.git xmc
 
-   This allows quick testing of local changes during development, and keep released version.
+   This allows quick testing of local changes during development while keeping the released version.
 
 #. You can check if the correct version is installed by running: 
    ::
 
       arduino-cli core list
 
-   you should be able to see the ``arduino-git:xmc core``.
+   You should be able to see the ``arduino-git:xmc core``.
 
 #. Update all submodule included in this project:
    ::
 
       git submodule update --init --recursive
    
-   If you are not familiar with submodules, check out `Git-Tools-Submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`_ 
+   If you are not familiar with git submodules, check out `Git-Tools-Submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`_ 
 
 #. Start developing |:tools:|!
 
 |:bell:| 
-If you encounter strange behavior with Arduino IDE during development, try cleaning up the IDE cache:
+If you encounter strange behavior with Arduino IDE during development, try cleaning up the Arduino IDE's cache:
 
    .. tabs::
 
       .. group-tab:: Windows
 
          .. code-block:: text
             
-            C:\User\"username"\AppData\Roaming\arduino-ide
+            %AppData%\arduino-ide
 
       .. group-tab:: Linux
 
          ::
 
             ~/.config/arduino-ide
 
-      .. group-tab::  macOS
+      .. group-tab:: macOS
 
          ::
          
@@ -95,15 +95,15 @@ If you encounter strange behavior with Arduino IDE during development, try clean
 Automated Build Checks
 -----------------------
 
-Currently a Github workflow is used for automatic compilation checking and releasing. Workflows are defined [here](https://github.com/Infineon/XMC-for-Arduino/tree/master/.github/workflows).
+Currently a GitHub Action workflow is used for automatic compilation checking and releasing. Workflows are defined [here](https://github.com/Infineon/XMC-for-Arduino/tree/master/.github/workflows).
 Before opening a Pull Request for your contribution, please add a git tag in the format `Vx.y.z` (e.g. V3.3.0) to trigger the release process in your fork and pass the compilation tests.
 
 Creating and Maintaining Third Party Libraries
 ------------------------------------------------
 Basics
 ^^^^^^^^
 The Arduino IDE allows for external libraries to be added to support specific devices and functions which are not part of the core setup. For details on creating libraries see the 
-[Arduino library specifications](https://arduino.github.io/arduino-cli/library-specification/). If you add additional libraries to this project, make sure to [document them](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html) accordingly.
+[Arduino library specification](https://arduino.github.io/arduino-cli/library-specification/). If you add additional libraries to this project, make sure to [document them](https://xmc-arduino.readthedocs.io/en/latest/builtin-libraries.html) accordingly.
 
 XMC-for-Arduino Configuration
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -117,14 +117,19 @@ When creating or maintaining third party or external libraries for XMC-for-Ardui
 
 If your library also supports other boards and architectures, add those in as well.
 
-Validation test
+Validation Test
 ----------------
-To test the XMC4arduino, we used unity to test some of the features of the arduino core & builtin library. 
+To validate the XMC-for-Arduino, we utilize Unity for testing various features of the Arduino core and built-in libraries.
 
-Tests are located in tests/arduino-core-tests and included as submodule in this project. Run  ``git submodule update --init --recursive`` to update them.  
+Tests are located in ``tests/arduino-core-tests`` and included as submodule in this project. Run  ``git submodule update --init --recursive`` to update them.  
+
+Code Checks
+----------------
+.. warning::
+
+   Code Checks are still a work in progress in this project.
 
-Code checks (WIP)
-----------------------
 Refer to ``libraries\CAN\Makefile.codecheck``. 
 
-Regarding formatting, we currently use `pre-commit <https://pre-commit.com/>`_ to automatically run clang-formatting to format all c/c++ code. Please install this python package, and follow the quick start (the pre-commit configuration file is already there). You should be able to format your code automatically on git commit!
+Regarding formatting, we currently use `pre-commit <https://pre-commit.com/>`_ to automatically run clang-formatting to format all C/C++ code.
+Please install this Python package, and follow the quick start (the pre-commit configuration file is already there). You should be able to format your code automatically on git commit!