Run MKDocs strict validation on new commit pushes. (#5173)

lrcouto · merelcht · web-flow · commit 6a94c024305b · 2025-10-24T13:38:17.000Z
* Add linkcheck job to github CI

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Add permissions

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Run on all pushes

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Edit  the correct file

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Install UV the same way we do on unit tests

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Fix MKdocs warnings

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Lint

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Add Lychee to github CI job

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Install lychee with cargo

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Add stricter validation to docs, fix broken anchors

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Remove lychee from CI

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Make anchor links more specific, run lincheck only on python 3.11

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;

* Update docs/build/slice_a_pipeline.md

Co-authored-by: Merel Theisen &lt;49397448+merelcht@users.noreply.github.com&gt;
Signed-off-by: L. R. Couto &lt;57910428+lrcouto@users.noreply.github.com&gt;

* Update docs/tutorials/add_another_pipeline.md

Co-authored-by: Merel Theisen &lt;49397448+merelcht@users.noreply.github.com&gt;
Signed-off-by: L. R. Couto &lt;57910428+lrcouto@users.noreply.github.com&gt;

---------

Signed-off-by: Laura Couto &lt;laurarccouto@gmail.com&gt;
Signed-off-by: L. R. Couto &lt;57910428+lrcouto@users.noreply.github.com&gt;
Co-authored-by: Merel Theisen &lt;49397448+merelcht@users.noreply.github.com&gt;
diff --git a/.github/workflows/docs-linkcheck.yml b/.github/workflows/docs-linkcheck.yml
@@ -0,0 +1,46 @@
+name: Check links in MkDocs
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+
+jobs:
+  linkcheck:
+    permissions:
+      contents: read
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: [ "3.11" ]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the latest version of uv with Python ${{inputs.python-version}}
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "latest"
+          python-version: ${{ inputs.python-version }}
+          activate-environment: true
+
+      - name: Install docs requirements
+        run: |
+          make install-docs-requirements
+
+      - name: Run MkDocs on strict mode.
+        run: |
+          mkdocs build --strict
diff --git a/docs/about/technical_steering_committee.md b/docs/about/technical_steering_committee.md
@@ -62,7 +62,7 @@ We look for commitment markers who can do the following:
 | [Ivan Danov](https://github.com/idanov)                  | [Palantir](https://www.palantir.com/)                                                   |
 | [Jitendra Gundaniya](https://github.com/jitu5)           | [QuantumBlack, AI by McKinsey](https://www.mckinsey.com/capabilities/quantumblack)      |
 | [Joel Schwarzmann](https://github.com/datajoely)         | [Aneira Health](https://www.aneira.health)                                              |
-| [Juan Luis Cano](https://github.com/astrojuanlu)         | [Canonical](www.canonical.com )                                                         |
+| [Juan Luis Cano](https://github.com/astrojuanlu)         | [Canonical](https://www.canonical.com )                                                         |
 | [Laura Couto](https://github.com/lrcouto)                | [QuantumBlack, AI by McKinsey](https://www.mckinsey.com/capabilities/quantumblack)      |
 | [Marcin Zabłocki](https://github.com/marrrcin)           | [Printify, Inc.](https://printify.com/)                                                 |
 | [Merel Theisen](https://github.com/merelcht)             | [QuantumBlack, AI by McKinsey](https://www.mckinsey.com/capabilities/quantumblack)      |
diff --git a/docs/about/telemetry.md b/docs/about/telemetry.md
@@ -76,7 +76,7 @@ more at https://docs.kedro.org/en/stable/configuration/telemetry.html
 ```
 
 You can hide this message by explicitly granting or denying consent. The
-[previous section](#how-do-i-withdraw-consent) explains how to deny consent by setting environment
+[previous section](#how-to-withdraw-consent) explains how to deny consent by setting environment
 variables or updating the `.telemetry` file. You can also grant consent by modifying or creating the
 `.telemetry` file manually. If the `.telemetry` file exists in the root folder of your Kedro
 project, set the `consent` variable to `true`. If the file does not exist, create it with the following content:
diff --git a/docs/build/run_a_pipeline.md b/docs/build/run_a_pipeline.md
@@ -189,7 +189,7 @@ kedro run --pipeline=my_pipeline
     If you specify `kedro run` without the `--pipeline` option, it runs the `__default__` pipeline from the dictionary returned by `register_pipelines()`.
 
 
-Further information about `kedro run` can be found in the [Kedro CLI documentation](../getting-started/commands_reference.md#run-the-project).
+Further information about `kedro run` can be found in the [Kedro CLI documentation](../getting-started/commands_reference.md#kedro-run).
 
 ## Run pipelines with IO
 
@@ -233,7 +233,7 @@ In a simple example, we define a `MemoryDataset` called `xs` to store our inputs
 
 ## Configure `kedro run` arguments
 
-The [Kedro CLI documentation](../getting-started/commands_reference.md#run-the-project) lists the available CLI options for `kedro run`. You can alternatively supply a configuration file that contains the arguments to `kedro run`.
+The [Kedro CLI documentation](../getting-started/commands_reference.md#kedro-run) lists the available CLI options for `kedro run`. You can alternatively supply a configuration file that contains the arguments to `kedro run`.
 
 Here is an example file named `config.yml`, but you can choose any name for the file:
 
diff --git a/docs/build/slice_a_pipeline.md b/docs/build/slice_a_pipeline.md
@@ -7,7 +7,7 @@ Sometimes it is desirable to run a subset, or a 'slice' of a pipeline's nodes. T
 
 ![](../meta/images/slice_pipeline_kedro_viz.gif)
 
-2. **Programmatically with the Kedro CLI.** You can also use the [Kedro CLI to pass parameters to `kedro run`](../getting-started/commands_reference.md#run-the-project) command and slice a pipeline. In this page, we illustrate the programmatic options that Kedro provides.
+2. **Programmatically with the Kedro CLI.** You can also use the [Kedro CLI to pass parameters to `kedro run`](../getting-started/commands_reference.md#kedro-run) command and slice a pipeline. In this page, we illustrate the programmatic options that Kedro provides.
 
 Let's look again at the example pipeline from the [pipeline introduction documentation](./pipeline_introduction.md#how-to-build-a-pipeline), which computes the variance of a set of numbers:
 
diff --git a/docs/configure/configuration_basics.md b/docs/configure/configuration_basics.md
@@ -121,7 +121,7 @@ CONF_SOURCE = "new_conf"
 ```
 
 ### How to change the configuration source folder at runtime
-Specify a source folder for the configuration files at runtime using the [`kedro run` CLI command](../getting-started/commands_reference.md#modifying-a-kedro-run) with the `--conf-source` flag as follows:
+Specify a source folder for the configuration files at runtime using the [`kedro run` CLI command](../getting-started/commands_reference.md#kedro-commands) with the `--conf-source` flag as follows:
 
 ```bash
 kedro run --conf-source=<path-to-new-conf-folder>
diff --git a/docs/deploy/single_machine.md b/docs/deploy/single_machine.md
@@ -38,7 +38,7 @@ docker pull <DockerID>/<image-name>
 The procedure for using other container registries, like AWS ECR or GitLab Container Registry, will be almost identical to the steps described above. However, authentication will be different for each solution.
 
 ## Package-based
-If you prefer not to use containerisation, you can instead package your Kedro project using [`kedro package`](../getting-started/commands_reference.md#deploy-the-project).
+If you prefer not to use containerisation, you can instead package your Kedro project using [`kedro package`](../getting-started/commands_reference.md#kedro-package).
 
 Run the following in your project’s root directory:
 
diff --git a/docs/develop/automated_testing.md b/docs/develop/automated_testing.md
@@ -39,7 +39,7 @@ dev = [
 pip install ."[dev]"
 ```
 
-Alternatively, you can individually install test requirements as you would install other packages with `pip`, making sure you have installed your project locally and your [project's virtual environment is active](../getting-started/install.md#create-a-virtual-environment-for-your-kedro-project).
+Alternatively, you can individually install test requirements as you would install other packages with `pip`, making sure you have installed your project locally and your [project's virtual environment is active](../getting-started/install.md#how-to-manually-create-a-virtual-environment-for-your-kedro-project).
 
 1. To install your project, navigate to your project root and run the following command:
 
@@ -142,7 +142,7 @@ It can be useful to see how much of your project is covered by tests. For this,
 
 ### Install `pytest-cov`
 
-Install `pytest` as you would install other packages with pip, making sure your [project's virtual environment is active](../getting-started/install.md#create-a-virtual-environment-for-your-kedro-project).
+Install `pytest` as you would install other packages with pip, making sure your [project's virtual environment is active](../getting-started/install.md#how-to-manually-create-a-virtual-environment-for-your-kedro-project).
 
 ```bash
 pip install pytest-cov
diff --git a/docs/getting-started/faq.md b/docs/getting-started/faq.md
@@ -38,7 +38,7 @@ This is a growing set of technical FAQs. The [product FAQs on the Kedro website]
 * [How do I specify additional configuration environments](../configure/configuration_basics.md#how-to-specify-additional-configuration-environments)?
 * [How do I change the default overriding configuration environment](../configure/configuration_basics.md#how-to-change-the-default-overriding-environment)?
 * [How do I use only one configuration environment](../configure/configuration_basics.md#how-to-use-only-one-configuration-environment)?
-* [How do I use Kedro without the rich library](../configure/configuration_basics.md#how-to-use-kedro-without-the-rich-library)?
+* [How do I use Kedro logging without the Rich library](../develop/logging.md#how-to-use-logging-without-the-rich-library)
 
 ### Advanced topics
 
diff --git a/docs/integrations-and-plugins/marimo.md b/docs/integrations-and-plugins/marimo.md
@@ -4,7 +4,7 @@ This guide explains how to set up Kedro programmatically from non-Jupyter enviro
 
 ## Overview
 
-Kedro Jupyter notebook users rely on the magic command `%load_ext kedro.ipython` to source their catalog, context, pipelines and session objects, see [Kedro and Notebooks](../integrations-and-plugins/kedro_and_notebooks.md) for more. This magic command automatically finds the location of the root Kedro project.
+Kedro Jupyter notebook users rely on the magic command `%load_ext kedro.ipython` to source their catalog, context, pipelines and session objects, see [Kedro and Notebooks](../integrations-and-plugins/notebooks_and_ipython/kedro_and_notebooks.md) for more. This magic command automatically finds the location of the root Kedro project.
 
 Such magic commands are not available in modern notebook interfaces such as Marimo or in short Python scripts. Yet, using Kedro for sharing configuration, credentials, or the data catalog across a project is still desired when developing data science projects.
 
diff --git a/docs/tutorials/add_another_pipeline.md b/docs/tutorials/add_another_pipeline.md
@@ -233,7 +233,7 @@ You can 'slice' the pipeline and specify just the portion you want to run by usi
 kedro run --pipeline=data_science
 ```
 
-There are a range of options to run sections of the default pipeline as described in the [pipeline slicing documentation](../build/slice_a_pipeline.md) and the ``kedro run`` [CLI documentation](../getting-started/commands_reference.md#modifying-a-kedro-run).
+There are a range of options to run sections of the default pipeline as described in the [pipeline slicing documentation](../build/slice_a_pipeline.md) and the ``kedro run`` [CLI documentation](../getting-started/commands_reference.md#kedro-run).
 
 ## Modular pipelines
 
diff --git a/docs/tutorials/spaceflights_tutorial_faqs.md b/docs/tutorials/spaceflights_tutorial_faqs.md
@@ -45,7 +45,7 @@ documentation on how to install relevant dependencies for kedro_datasets.pandas.
 https://docs.kedro.org/en/stable/develop/dependencies/
 ```
 
-The Kedro Data Catalog is missing [dependencies needed to parse the data](../develop/dependencies.md#install-dependencies-related-to-the-data-catalog). Check that you have [all the project dependencies to `requirements.txt`](./tutorial_template.md#install-project-dependencies) and then call `pip install -r requirements.txt` to install them.
+The Kedro Data Catalog is missing [dependencies needed to parse the data](../develop/dependencies.md#install-dependencies-related-to-the-data-catalog). Check that you have all the project dependencies to `requirements.txt` and then call `pip install -r requirements.txt` to install them.
 
 ### Pipeline run
 
diff --git a/kedro/io/data_catalog.py b/kedro/io/data_catalog.py
@@ -352,7 +352,9 @@ def __contains__(self, dataset_name: str) -> bool:
             is not None
         )
 
-    def __eq__(self, other) -> bool:  # type: ignore[no-untyped-def]
+    def __eq__(
+        self, other: Any
+    ) -> bool:  # Any type to silence warning on mkdocs strict mode
         """
         Compare two catalogs based on materialized datasets, lazy datasets and all dataset factory patterns.
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -7,7 +7,7 @@ theme:
   name: material
   custom_dir: docs/overrides/
   palette:
-     # Palette toggle for light mode
+    # Palette toggle for light mode
     - scheme: light
       toggle:
         icon: material/white-balance-sunny
@@ -465,3 +465,14 @@ nav:
           - Kedro telemetry: about/telemetry.md
   - Kedro-Viz: https://docs.kedro.org/projects/kedro-viz/en/stable/
   - Kedro-Datasets: https://docs.kedro.org/projects/kedro-datasets/en/stable/
+
+not_in_nav: |
+  diagrams/
+  readme.md
+  integrations-and-plugins/marimo.md
+
+validation:
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
+  anchors: warn
