Check links in markdown files (#323)

* We currently check links for Markdown/RST files included in the documentation builds, however this only covers files under `docs/source`
* This PR checks all Markdown files including those at the root of the repo and in the `examples` dir.
* Fixes some mal-formatted MD markup
* Fixes a broken link in eval documentation

Closes #176


## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AIQToolkit/blob/develop/docs/source/resources/contributing.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
  - Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.

Authors:
  - David Gardner (https://github.com/dagardner-nv)

Approvers:
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: #323

Author: dagardner-nv

.pre-commit-config.yaml

@@ -19,22 +19,32 @@ repos:
     hooks:
       - id: isort
         args: ["--filter-files", "--settings-file=./pyproject.toml"]
+
   - repo: https://github.com/PyCQA/flake8
     rev: 7.0.0
     hooks:
       - id: flake8
         entry: pflake8
         additional_dependencies: [pyproject-flake8]
         args: ["--config=./pyproject.toml"]
+
   - repo: https://github.com/google/yapf
     rev: v0.43.0
     hooks:
       - id: yapf
         args: ["-i", "--style", "./pyproject.toml"]
+
   - repo: https://github.com/astral-sh/uv-pre-commit
     rev: 0.6.2
     hooks:
       - id: uv-lock
 
+  - repo: https://github.com/tcort/markdown-link-check
+    rev: v3.12.2
+    hooks:
+      - id: markdown-link-check
+        args: ["-q", "--config", "ci/markdown-link-check-config.json"]
+        exclude: "^src/aiq/meta/pypi\\.md$"
+
 default_language_version:
   python: python3

ci/markdown-link-check-config.json

@@ -0,0 +1,10 @@
+{
+    "ignorePatterns": [
+        {"pattern": "^https?://localhost:.*$"},
+        {"pattern": "^https?://$"},
+        {"pattern": "^https://(platform\\.)?openai\\.com"},
+        {
+            "pattern": "^https://code\\.visualstudio\\.com$"
+        }
+    ]
+}

docs/source/reference/cli.md

@@ -419,7 +419,7 @@ Options:
   -f, --fields [all|package|version|component_name|description|developer_notes]
                                   Fields used when applying query.
   --help                          Show this message and exit.
-  ```
+```
 
 ### Channels Information
 
@@ -440,7 +440,7 @@ Usage: aiq info channels [OPTIONS] COMMAND [ARGS]...
 Options:
   -t, --type TEXT  Filter the results by channel type.
   --help           Show this message and exit.
-  ```
+```
 
 ## Configuration Commands
 
@@ -549,7 +549,7 @@ Commands:
   pull     Pull AIQ toolkit artifacts from a remote registry by package name.
   remove   Remove AIQ toolkit artifact from a remote registry by name and version.
   search   Search for AIQ toolkit artifacts from remote registry.
-  ```
+```
 
 #### Publishing AIQ Toolkit Components
 

docs/source/workflows/evaluate.md

@@ -124,7 +124,7 @@ Evaluation is dependent on the judge LLM's ability to accurately evaluate the ge
     3)- meta/llama-3.1-70b-instruct
     4)- meta/llama-3.3-70b-instruct
 ```
-For a complete list of up-to-date judge LLMs, refer to the [RAGAS NV metrics leadership board](https://github.com/explodinggradients/ragas/blob/main/src/ragas/metrics/_nv_metrics.py)
+For a complete list of up-to-date judge LLMs, refer to the [RAGAS NV metrics leadership board](https://github.com/explodinggradients/ragas/blob/main/ragas/src/ragas/metrics/_nv_metrics.py)
 
 ### Trajectory Evaluator
 This evaluator uses the intermediate steps generated by the workflow to evaluate the workflow trajectory. The evaluator configuration includes the evaluator type and any additional parameters required by the evaluator.

examples/agno_personal_finance/README.md

@@ -157,7 +157,7 @@ curl -X 'POST' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{"inputs": "My financial goal is to retire at age 60.  I am currently 40 years old, working as a Machine Learning engineer at NVIDIA."}'
-  ```
+```
 
 ### Expected API Output
 The API response should look like this:

examples/email_phishing_analyzer/README.md

@@ -155,7 +155,7 @@ curl -X 'POST' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{"input_message": "Dear [Customer], Thank you for your purchase on [Date]. We have processed a refund of $[Amount] to your account. Please provide your account and routing numbers so we can complete the transaction. Thank you, [Your Company]"}'
-  ```
+```
 
 ### Expected API Output
 The API response should look like this:

examples/simple_calculator/README.md

@@ -246,7 +246,7 @@ curl -X 'POST' \
   -H 'accept: application/json' \
   -H 'Content-Type: application/json' \
   -d '{"input_message": "Is the product of 2 * 4 greater than the current hour of the day?"}'
-  ```
+```
 
 ### Expected API Output
 The API response should be similar to the following:
@@ -257,6 +257,7 @@ The API response should be similar to the following:
   "output": "No, the product of 2 * 4 (which is 8) is less than the current hour of the day (which is 16)."
 }
 ```
+
 ## Accessing Request Metadata
 Users can define custom routes that are dynamically added to the API server, and capture HTTP request metadata such
 as the method, URL path, URL scheme, headers, query parameters, path parameters, host, port, and cookies.
@@ -274,7 +275,7 @@ general:
         method: POST
         description: Gets the request attributes from the request.
         function_name: current_request_attributes
-  ```
+```
 
 ### Access the request metadata
 Get the instance of the `aiq.builder.context.AIQContext` object using the `aiq.builder.context.AIQContext.get()` method. This will give you access to the metadata method which holds the request attributes defined by the user on request. A complete example of the function can be found in `src/aiq/tool/server_tools.py.`