Migrated from markdown-lint-checker to lychee action (#209)

* Migrated from markdown-lint-checker to lychee action

* Migrated from markdown-lint-checker to lychee action

* Added lychee configs

* Fixed broken links

* Added json for local usage back

Author: soumeh01

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 ## Fixes
 <!-- List the GitHub issue this PR resolves -->
-- [#<issue-number>](https://github.com/Open-CMSIS-Pack/vscode-cmsis-solution/issues/<issue-number>)
+- #<issue-number> (for example: #123)
 
 ## Changes
 <!-- List the changes this PR introduces -->

.github/lychee.toml

@@ -0,0 +1,44 @@
+# For all options, see <https://lychee.cli.rs/usage/config/>
+
+# Verbose program output
+# Accepts log level: "error", "warn", "info", "debug", "trace"
+verbose = "info"
+
+# Interactive progress bar while checking links.
+# Disabled for CI usage
+no_progress = true
+
+# Enable link caching. This can be helpful to avoid checking the same links on
+# multiple runs.
+cache = true
+
+accept = [
+  "200"
+]
+
+# Maximum number of allowed redirects.
+max_redirects = 2
+
+# Maximum number of allowed retries before a link is declared dead.
+max_retries = 2
+
+# Only test links with the given schemes
+# Omit to check links with any other scheme.
+scheme = ["http", "https", "file"]
+
+# Exclude links
+exclude = [
+  # Exclude links as cookies needed to be accepted
+  'https://developer.arm.com',
+  'https://www.st.com/en/development-tools'
+]
+
+# Exclude paths from getting checked. The values are treated as regular expressions
+exclude_path = [
+  "(^|[\\\\/])CHANGELOG\\.md$", # skip changelog file
+    "\\.txt$",            # skip .txt extensions
+    "\\.html$",           # skip .html extensions
+    "test-data/",         # skip directories named "test",
+    "test-results/",      # skip directories named "test",
+    "test-workspace/",    # skip directories named "test"
+]

.github/workflows/markdown.yml

@@ -78,8 +78,8 @@ jobs:
         uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
 
       - name: Check Links
-        uses: tcort/github-action-markdown-link-check@e7c7a18363c842693fadde5d41a3bd3573a7a225 # v1.1.2
+        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
         with:
-          use-quiet-mode: 'no'
-          use-verbose-mode: 'yes'
-          config-file: '.github/markdown-link-check.jsonc'
+          args: --config .github/lychee.toml './**/*.md'
+          fail: true
+          jobSummary: true

.github/workflows/nightly.yml

@@ -34,11 +34,11 @@ jobs:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
       - name: Validate Links
-        uses: tcort/github-action-markdown-link-check@e7c7a18363c842693fadde5d41a3bd3573a7a225 # v1.1.2
+        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
         with:
-          use-quiet-mode: 'no'
-          use-verbose-mode: 'yes'
-          config-file: '.github/markdown-link-check.jsonc'
+          args: --config .github/lychee.toml './**/*.md'
+          fail: true
+          jobSummary: true
 
   build:
     if: github.repository == 'Open-CMSIS-Pack/vscode-cmsis-solution'

DEVELOPMENT.md

@@ -111,15 +111,13 @@ Before running a release, check the following:
 
      `<version>` must match a [project manager schemas tag](https://github.com/Open-CMSIS-Pack/devtools/releases)
 
-2. User guide is up-to-date at [MDK-Packs/vscode-cmsis-solution-docs@main](https://github.com/MDK-Packs/vscode-cmsis-solution-docs/tree/main/site).
+2. User guide is up-to-date at [MDK-Packs/vscode-cmsis-solution-docs@main](https://github.com/MDK-Packs/vscode-cmsis-solution-docs/tree/main/docs).
 
 3. Update and review [CHANGELOG.md](CHANGELOG.md)
 
    Add all changes relevant for the upcoming release into the `[Unreleased]` section. This section
    is automatically replaced by the release version during the release workflow.
 
-4. [Release Assessment](https://armh.sharepoint.com/sites/pwa/PJ1000480/SitePages/Assessments.aspx) for `CMSIS Solution Extension` is approved.
-
 ## Release versioning
 
 This repository follows the VS Code Marketplace pre-release recommendation:
@@ -172,7 +170,7 @@ When a new RPC method or data type is needed:
 3. **Implement the server side** in [`ProjMgrRpcServer.cpp`](https://github.com/Open-CMSIS-Pack/devtools/blob/main/tools/projmgr/src/ProjMgrRpcServer.cpp) in the `devtools` repository.
 
 4. **Implement the client side** in this extension:
-   - Copy the regenerated `rpc-interface.ts` into [src/json-rpc/interface/](src/json-rpc/interface/) and update [version.txt](src/json-rpc/interface/version.txt) to the new API version.
+   - Copy the regenerated `rpc-interface.ts` into `src/json-rpc/interface/` and update `src/json-rpc/interface/version.txt` to the new API version.
    - Expose the new method via `CsolutionService` in [src/json-rpc/csolution-rpc-client.ts](src/json-rpc/csolution-rpc-client.ts).
    - Use the method from the relevant data source or manager in [src/data-manager/](src/data-manager/).
 

README.md

@@ -22,7 +22,7 @@ Arm CMSIS Solution provides the following views:
 - [Manage Solution view](#manage-solution-view): Manage your solutions with multiple targets, projects, and build types to define the scope of your applications.
 - [Software Components view](#software-components-view): Access reusable building blocks that are provided in software packs.
 
-[Settings](https://mdk-packs.github.io/vscode-cmsis-solution-docs/configuration.html#configure-the-extension): Configure features like pack download, [clangd](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd), or usage of web services. When **Use Web Services** is enabled, Arm CMSIS Solution gets from [keil.arm.com](https://www.keil.arm.com/packs/) information about devices, boards, and examples that are provided in software packs.
+[Settings](https://mdk-packs.github.io/vscode-cmsis-solution-docs/installation.html#configure-the-extension): Configure features like pack download, [clangd](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd), or usage of web services. When **Use Web Services** is enabled, Arm CMSIS Solution gets from [keil.arm.com](https://www.keil.arm.com/packs/) information about devices, boards, and examples that are provided in software packs.
 
 Arm CMSIS Solution works as a standalone tool and can also interact with other VS Code extensions:
 
@@ -114,9 +114,9 @@ The YML syntax support in the editor detects errors, provides auto completion, a
 
 ## Run and Debug
 
-Arm CMSIS Solution generates the [Run and Debug configuration](https://mdk-packs.github.io/vscode-cmsis-solution-docs/conf_debug.html) files including files `.vscode/launch.json` and `.vscode/tasks.json` for the [Arm CMSIS Debugger](https://marketplace.visualstudio.com/items?itemName=Arm.vscode-cmsis-debugger) and various debug adapters (such as CMSIS-DAP, ULINK, JLink, and ST-Link). The [Manage Solution view](#manage-solution-view) simplifies the setup and supports single-core and multi-core configurations.
+Arm CMSIS Solution generates the [Run and Debug configuration](https://mdk-packs.github.io/vscode-cmsis-solution-docs/debug.html#configure-run-and-debug) files including files `.vscode/launch.json` and `.vscode/tasks.json` for the [Arm CMSIS Debugger](https://marketplace.visualstudio.com/items?itemName=Arm.vscode-cmsis-debugger) and various debug adapters (such as CMSIS-DAP, ULINK, JLink, and ST-Link). The [Manage Solution view](#manage-solution-view) simplifies the setup and supports single-core and multi-core configurations.
 
-The [Run and Debug configuration](https://mdk-packs.github.io/vscode-cmsis-solution-docs/configuration.html#configure-run-and-debug) is stored in the `csolution.yml` file under `target-set:` as shown below:
+The [Run and Debug configuration](https://mdk-packs.github.io/vscode-cmsis-solution-docs/debug.html#configure-run-and-debug) is stored in the `csolution.yml` file under `target-set:` as shown below:
 
 ```yml
   target-types:

docs/third-party-licenses.md

@@ -13,7 +13,7 @@ Report prepared at: 03/03/2026, 10:51:48
 |@vscode/codicons|0.0.44|https://github.com/microsoft/vscode-codicons|https://github.com/microsoft/vscode-codicons/blob/main/LICENSE|
 |@vscode/webview-ui-toolkit|1.4.0|https://github.com/microsoft/vscode-webview-ui-toolkit|https://github.com/microsoft/vscode-webview-ui-toolkit/blob/main/LICENSE|
 |antd|5.29.3|https://ant.design|https://github.com/ant-design/ant-design/blob/master/LICENSE|
-|async-mutex|0.5.0|https://https://github.com/DirtyHairy/async-mutex|https://github.com/DirtyHairy/async-mutex/blob/master/LICENSE|
+|async-mutex|0.5.0|https://github.com/DirtyHairy/async-mutex|https://github.com/DirtyHairy/async-mutex/blob/master/LICENSE|
 |eta|4.5.1|https://github.com/eta-dev/eta|https://github.com/eta-dev/eta/blob/main/LICENSE|
 |fetch-blob|4.0.0|https://github.com/node-fetch/fetch-blob|https://github.com/node-fetch/fetch-blob/blob/main/LICENSE|
 |formdata-polyfill|4.0.10|https://github.com/jimmywarting/FormData|https://github.com/jimmywarting/FormData/blob/master/LICENSE|

src/ARCHITECTURE.md

@@ -27,15 +27,15 @@ The Solution Outline docks into the left panel presenting a tree view for the se
 
 The Create Solution dialog shall present boards, devices, and draft projects to the user. The draft project shall be used to initialize a new solution workspace.
 
-[TO BE DOCUMENTED](views/create-solution)
+[TO BE DOCUMENTED](views/create-solutions)
 
 ### Configure Solution
 
 [TO BE DOCUMENTED](views/manage-layers)
 
 ### Context Selection
 
-[TO BE DOCUMENTED](views/context-selection)
+[TO BE DOCUMENTED](views/manage-solution)
 
 ### Manage Components