DeepLabCut · deruyter92 · Mar 20, 2026 · Mar 5, 2026 · Mar 5, 2026 · Mar 5, 2026
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -15,7 +15,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v6
       - name: Annotate locations with typos
         uses: codespell-project/codespell-problem-matcher@v1
       - name: Codespell

diff --git a/.github/workflows/docs_and_notebooks_checks.yml b/.github/workflows/docs_and_notebooks_checks.yml
@@ -0,0 +1,59 @@
+name: Docs & notebooks freshness and formatting checks
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  staleness:
+    name: Docs and notebooks scan (read-only)
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - name: Checkout repository (full history for git dates)
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - name: Install staleness tool dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install "pydantic>=2,<3" pyyaml "nbformat>=5"
+
+      - name: Run staleness report (read-only)
+        run: |
+          python tools/docs_and_notebooks_check.py \
+          --config tools/docs_and_notebooks_report_config.yml \
+          --out-dir tmp/docs_nb_checks \
+          report
+
+
+      # Optional: run check mode (will fail only once you populate allowlists in config)
+      - name: Run staleness policy check (optional gate)
+        continue-on-error: true
+        run: |
+          python tools/docs_and_notebooks_check.py \
+          --config tools/docs_and_notebooks_report_config.yml \
+          --out-dir tmp/docs_nb_checks \
+          --no-step-summary \
+          check
+
+      - name: Upload staleness artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: staleness-report
+          path: |
+            tmp/docs_nb_checks/*.json
+            tmp/docs_nb_checks/*.md
+          if-no-files-found: error
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -87,7 +87,7 @@ jobs:
         shell: bash -el {0}  # Important: activates the conda environment
         run: |
           python -m pip install --upgrade pip setuptools wheel
-          pip install --no-cache-dir -e .
+          pip install --no-cache-dir -e . --group dev
 
       - name: Install ffmpeg
         run: |

diff --git a/.gitignore b/.gitignore
@@ -136,6 +136,8 @@ ENV/
 # mypy
 .mypy_cache/
 
+# Automated docs checks
+**/tmp/docs_nb_checks/
 
 
 # Automatic test selection report

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -26,3 +26,20 @@ repos:
     hooks:
       - id: black
         language_version: python3
+  - repo: local
+    hooks:
+      - id: dlc-docs-notebooks-check
+        name: DLC docs+notebooks staleness/check + nbformat validate + normalization
+        entry: python tools/docs_and_notebooks_check.py
+        language: python
+        pass_filenames: true
+        files: ^(docs/|examples/(JUPYTER|COLAB)/|tools/).*(\.md|\.ipynb)$
+        args:
+          - --config
+          - tools/docs_and_notebooks_report_config.yml
+          - check
+          - --targets
+        additional_dependencies:
+          - "pydantic>=2,<3"
+          - "pyyaml"
+          - "nbformat>=5"
diff --git a/docs/Governance.md b/docs/Governance.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2026-02-10'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 (governance-model)=
 # Governance Model of DeepLabCut
 (adapted from https://napari.org/stable/community/governance.html)

diff --git a/docs/HelperFunctions.md b/docs/HelperFunctions.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-06-30'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 (helper-functions)=
 # Helper & Advanced Optional Function Documentation
 

diff --git a/docs/MISSION_AND_VALUES.md b/docs/MISSION_AND_VALUES.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-02-28'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 (mission-and-values)=
 # Mission and Values of DeepLabCut
 

diff --git a/docs/ModelZoo.md b/docs/ModelZoo.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-07-06'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 (file:model-zoo)=
 # The DeepLabCut Model Zoo!
 

diff --git a/docs/Overviewof3D.md b/docs/Overviewof3D.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-10-14'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 (3D-overview)=
 # 3D DeepLabCut
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2022-08-30'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 Please see https://deeplabcut.github.io/DeepLabCut for documentation on how to use this software. 
 
 This directory contains the source code for the docs.
diff --git a/docs/UseOverviewGuide.md b/docs/UseOverviewGuide.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2026-02-10'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 (overview)=
 # 🥳 Get started with DeepLabCut: our key recommendations 
 

diff --git a/docs/beginner-guides/Training-Evaluation.md b/docs/beginner-guides/Training-Evaluation.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-02-28'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 # Neural Network training and evaluation in the GUI
 <img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="150" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50">
 

diff --git a/docs/beginner-guides/beginners-guide.md b/docs/beginner-guides/beginners-guide.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2026-03-03'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 (beginners-guide)=
 # Using DeepLabCut 
 <img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="150" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50">

diff --git a/docs/beginner-guides/labeling.md b/docs/beginner-guides/labeling.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-06-30'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 (labeling)=
 # Labeling GUI
 

diff --git a/docs/beginner-guides/manage-project.md b/docs/beginner-guides/manage-project.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-06-30'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 # Setting up what keypoints to track
 <img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="150" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50">
 

diff --git a/docs/beginner-guides/video-analysis.md b/docs/beginner-guides/video-analysis.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-06-30'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 # Video Analysis with DeepLabCut
 <img src="https://images.squarespace-cdn.com/content/v1/57f6d51c9f74566f55ecf271/1572296495650-Y4ZTJ2XP2Z9XF1AD74VW/ke17ZwdGBToddI8pDm48kMulEJPOrz9Y8HeI7oJuXxR7gQa3H78H3Y0txjaiv_0fDoOvxcdMmMKkDsyUqMSsMWxHk725yiiHCCLfrh8O1z5QPOohDIaIeljMHgDF5CVlOqpeNLcJ80NK65_fV7S1UZiU3J6AN9rgO1lHw9nGbkYQrCLTag1XBHRgOrY8YAdXW07ycm2Trb21kYhaLJjddA/DLC_logo_blk-01.png?format=1000w" width="150" title="DLC-live" alt="DLC LIVE!" align="right" vspace = "50">
 

diff --git a/docs/benchmark.md b/docs/benchmark.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-02-28'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 # DeepLabCut benchmark
 
 For further information and the leaderboard, see [the official homepage](https://benchmark.deeplabcut.org/).

diff --git a/docs/citation.md b/docs/citation.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2024-10-27'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 # How to Cite DeepLabCut
 
 Thank you for using DeepLabCut! Here are our recommendations for citing and documenting your use of DeepLabCut in your Methods section:

diff --git a/docs/convert_maDLC.md b/docs/convert_maDLC.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-02-28'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 (convert-maDLC)=
 # How to convert a pre-2.2 project for use with DeepLabCut 2.2 or later
 

diff --git a/docs/course.md b/docs/course.md
@@ -1,3 +1,9 @@
+---
+deeplabcut:
+  last_content_updated: '2025-06-30'
+  last_metadata_updated: '2026-03-06'
+  ignore: false
+---
 # DeepLabCut Self-paced Course
 
 ::::{warning}

diff --git a/docs/dlc-live/deeplabcutlive.md b/docs/dlc-live/deeplabcutlive.md
@@ -1,3 +1,8 @@
+---
+deeplabcut:
+  last_metadata_updated: '2026-03-17'
+  ignore: false
+---
 (deeplabcut-live)=
 # Running DeepLabCut models in real-time
 

diff --git a/docs/dlc-live/dlc-live-gui/index.md b/docs/dlc-live/dlc-live-gui/index.md
@@ -1,3 +1,8 @@
+---
+deeplabcut:
+  last_metadata_updated: '2026-03-17'
+  ignore: false
+---
 # DeepLabCut-live-GUI
 
 A graphical application for **real-time pose estimation with DeepLabCut** using one or more cameras.
@@ -71,5 +76,5 @@ Before getting started, be aware of the following constraints:
 ## Feedback, issues, and contributions
 
 > *This project is under active development. Feedback from real experimental use is highly valued.*
-> 
+>
 > [Please report issues, suggest features, or contribute to the codebase on GitHub !](https://github.com/DeepLabCut/DeepLabCut-live-GUI)
diff --git a/docs/dlc-live/dlc-live-gui/quickstart/install.md b/docs/dlc-live/dlc-live-gui/quickstart/install.md
@@ -1,3 +1,8 @@
+---
+deeplabcut:
+  last_metadata_updated: '2026-03-17'
+  ignore: false
+---
 # Installation
 
 This page explains how to install **DeepLabCut-live-GUI** for interactive, real‑time pose estimation.

diff --git a/docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/aravis_backend.md b/docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/aravis_backend.md
@@ -1,3 +1,8 @@
+---
+deeplabcut:
+  last_metadata_updated: '2026-03-17'
+  ignore: false
+---
 (file:dlclivegui-camera-aravis-backend)=
 # Aravis backend
 

diff --git a/docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/basler_backend.md b/docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/basler_backend.md
@@ -1,3 +1,8 @@
+---
+deeplabcut:
+  last_metadata_updated: '2026-03-17'
+  ignore: false
+---
 (file:dlclivegui-basler-backend)=
 # Basler backend
 
@@ -11,7 +16,7 @@ This backend requires the optional `pypylon` dependency. If `pypylon` is not ins
 
 ---
 
-## Features & design 
+## Features & design
 
 - Native Basler camera support via **pypylon** (Pylon SDK bindings).
 - Best-effort device discovery without opening cameras (enumerates `DeviceInfo` entries).

diff --git a/docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/camera_support.md b/docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/camera_support.md
@@ -1,3 +1,8 @@
+---
+deeplabcut:
+  last_metadata_updated: '2026-03-17'
+  ignore: false
+---
 (file:dlclivegui-camera-support)=
 # Camera support
 
@@ -32,9 +37,9 @@ You can select the backend in the GUI from the "Backend" dropdown, or in your co
 Below are some general recommendations for backend selection based on your operating system and camera type.
 
 ```{note}
-Please understand this may not reflect the exact capabilities for every setup. 
+Please understand this may not reflect the exact capabilities for every setup.
 
-Let us know about your experience with different cameras and backends on different platforms to help us improve our documentation and support! 
+Let us know about your experience with different cameras and backends on different platforms to help us improve our documentation and support!
 ```
 
 ### Windows
@@ -89,5 +94,3 @@ Install vendor-provided camera drivers and SDK. CTI files are typically in:
 | Windows | ✅ | ✅ | ❌ | ✅ |
 | Linux | ✅ | ✅ | ✅ | ✅ |
 | macOS | ✅ | ❌ | ⚠️ | ✅ |
-
-
diff --git a/docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/gentl_backend.md b/docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/gentl_backend.md
@@ -1,3 +1,8 @@
+---
+deeplabcut:
+  last_metadata_updated: '2026-03-17'
+  ignore: false
+---
 # GenTL backend
 
 The GenTL backend provides support for **GenICam / GenTL** compatible cameras using the **Harvesters** Python library (a GenTL consumer).

diff --git a/docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/opencv_backend.md b/docs/dlc-live/dlc-live-gui/user_guide/cameras_backends/opencv_backend.md
@@ -1,3 +1,8 @@
+---
+deeplabcut:
+  last_metadata_updated: '2026-03-17'
+  ignore: false
+---
 (file:dlclivegui-opencv-backend)=
 # OpenCV backend
 

diff --git a/docs/dlc-live/dlc-live-gui/user_guide/misc/misc_landing.md b/docs/dlc-live/dlc-live-gui/user_guide/misc/misc_landing.md
@@ -1,3 +1,8 @@
+---
+deeplabcut:
+  last_metadata_updated: '2026-03-17'
+  ignore: false
+---
 # Additional resources
 
 In this section, you can find additional resources related to the GUI and DLC-live, including:

diff --git a/docs/dlc-live/dlc-live-gui/user_guide/misc/modelzoo_downloads.md b/docs/dlc-live/dlc-live-gui/user_guide/misc/modelzoo_downloads.md
@@ -1,3 +1,8 @@
+---
+deeplabcut:
+  last_metadata_updated: '2026-03-17'
+  ignore: false
+---
 (file:dlclivegui-pretrained-models)=
 # Pre-trained models