Markdown link checker job

.github/markdown-link-check.json

@@ -0,0 +1,10 @@
+{
+  "httpHeaders": [
+    {
+      "urls": ["https://github.com/", "https://guides.github.com/", "https://help.github.com/", "https://docs.github.com/"],
+      "headers": {
+        "Accept-Encoding": "zstd, br, gzip, deflate"
+      }
+    }
+  ],
+}

.github/workflows/e2e_test.yaml

@@ -5,7 +5,7 @@ on:
     paths:
       - '.github/workflows/robot-tests.yml'
       - 'test/**'
-      - '!test/README.md'
+      - '!test/RobotTests.md'
   workflow_dispatch:
 
 concurrency:

.github/workflows/markdown.yml

@@ -0,0 +1,24 @@
+name: markdown
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/markdown.yml'
+      - '.github/markdownlint-link-check.json'
+      - '**/*.md'
+
+# Declare default permissions as read only.
+permissions: read-all
+
+jobs:
+  markdown-link-checker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout cmsis-toolbox
+        uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+
+      - uses: gaurav-nelson/github-action-markdown-link-check@25b2c436c653f0d4500d3c2df86e5c14e71e44e1 # master
+        with:
+          use-verbose-mode: 'yes'
+          check-modified-files-only: 'yes'
+          base-branch: ${{ github.base_ref }}
+          config-file: '.github/markdown-link-check.json'

docs/CubeMX.md

@@ -25,7 +25,7 @@ This chapter explains how to use [STM32CubeMX](https://www.st.com/en/development
 
 The `component: Device:CubeMX` connects a *csolution project* to CubeMX. This component imports the CubeMX generated files for a selected `device:` or `board:` using the [generator import file](YML-CBuild-Format.md#generator-import-file) (`*.cgen.yml`). This `*.cgen.yml` file is similar to a [software layer](build-overview.md#software-layers) but managed by CubeMX and should be not modified directly.
 
-An example project created with CubeMX can be found in [**csolution-examples/CubeMX**](https://github.com/Open-CMSIS-Pack/csolution-examples/CubeMX).
+An example project created with CubeMX can be found in [**csolution-examples/CubeMX**](https://github.com/Open-CMSIS-Pack/csolution-examples/tree/main/CubeMX).
 
 >**Notes:**
 >

docs/README.md

@@ -19,7 +19,7 @@ Thank you for using the **CMSIS-Toolbox** that provides command-line tools for:
 
 - [**Generate Application from Components**](Apps-from-components.md) explains the structure of a software pack and how it can be used in an application. It also describes how to upgrade software packs.
 
-- [**Application Reference Examples**](Apps-ref-examples.md) explains how to use and create examples that show middleware usage on on many different evaluation boards including custom hardware.
+- [**Application Reference Examples**](App-ref-examples.md) explains how to use and create examples that show middleware usage on on many different evaluation boards including custom hardware.
 
 - [**Configure STM32 Devices with CubeMX**](CubeMX.md) explains how to use [STM32CubeMX](https://www.st.com/en/development-tools/stm32cubemx.html) to manage device and board configuration.
 

docs/YML-Input-Format.md

@@ -1634,7 +1634,7 @@ Add source files to a project.
 
 > **Note:** 
 > 
-> It is also possible to specify a [Linker Script](Linker-Script-Management.md). Files with the extension `.sct`, `.scf`, `.ld`, and `.icf` are recognized as Linker Script files.
+> It is also possible to specify a [Linker Script](build-overview.md#linker-script-management). Files with the extension `.sct`, `.scf`, `.ld`, and `.icf` are recognized as Linker Script files.
 
 **Example:**
 

docs/build-overview.md

@@ -119,7 +119,7 @@ Output Files             | Description
 [*.cbuild.yml](YML-CBuild-Format.md#file-structure-of-cbuild-yml)      | Build description of a single [`*.cproject.yml`](YML-Input-Format.md#project-file-structure) input file (replaces *.CPRJ in CMSIS-Toolbox 2.3 - schedule for Q1'24)
 [Project Build Files *.cprj](https://arm-software.github.io/CMSIS_5/Build/html/cprjFormat_pg.html) | Project build information in legacy format.
 [Run-Time Environment (RTE)](#rte-directory-structure)  | Contains the user configured files of a project along with RTE_Components.h inventory file.
-[Linker Script Files](Linker-Script-Management.md#automatic-linker-script-generation) | Header file that describes the memory resources.
+[Linker Script Files](#automatic-linker-script-generation) | Header file that describes the memory resources.
 
 To build an application project, the `csolution` command `convert` executes the following steps:
 
@@ -424,7 +424,7 @@ can share a `layer` with common configuration settings.
 
 #### Software Layers in Packs
 
-A collection of software layers can be stored in software packs using the element [`<clayers>`](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_clayers_pg.html). Using the `csolution` command `list layers` it is possible to identify compatible software by iterating the [`layers:` - `type:`](YML-Input-Format.md#layers---type)
+A collection of software layers can be stored in software packs using the element [`<clayers>`](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_csolution_pg.html). Using the `csolution` command `list layers` it is possible to identify compatible software by iterating the [`layers:` - `type:`](YML-Input-Format.md#layers---type)
  [`connections`](YML-Input-Format.md#connections).
 filter conditions to it. In combination with interfaces specifications, an interactive IDE should be able to display suitable layers that could be added to an application.
 

docs/build-tools.md

@@ -323,7 +323,7 @@ List compatible layers for `./fxls8962_normal_spi.csolution.yml` and the context
 csolution list layers ./fxls8962_normal_spi.csolution.yml -c *+frdmk22f_agmp03
 ```
 
-Refer to [Working with Layers](build-overview#working-with-layers) for more information.
+Refer to [Working with Layers](build-overview.md#working-with-layers) for more information.
 
 ### Use Generators (i.e. CubeMX)
 

test/RobotTests.md

@@ -72,7 +72,7 @@ robot --test "Validate build-c Example"  test/test.robot
 
 ## Adding Tests
 
-The test cases in [test.robot](./test.robot) are implemented in a data-driven style, where each test case utilizes a single higher-level keyword to encapsulate the test workflow. To incorporate a new example for validation, follow the steps outlined below.
+The test cases in [local_example_tests.robot](./local_example_tests.robot) are implemented in a data-driven style, where each test case utilizes a single higher-level keyword to encapsulate the test workflow. To incorporate a new example for validation, follow the steps outlined below.
 
 - Add Example under [data](./data/) directory.
 - Add test details under **Test Cases** section following below conventions