Use docs_nb_checks as output directory

Rename OUTPUT_FILENAME from 'nb_docs_status' to 'docs_nb_checks' and use it for the default --out-dir (tmp/docs_nb_checks). Update the README to show the check command as a fenced code block and clarify allowlist behavior. Update .gitignore to ignore the new tmp/docs_nb_checks path.
deruyter92 · Mar 20, 2026 · Mar 5, 2026 · Mar 5, 2026 · Mar 5, 2026 · Mar 5, 2026
commit 908055665dc3699de7ff9617d0e4a45d8db16277
diff --git a/.github/tools/docs_and_notebooks_check.py b/.github/tools/docs_and_notebooks_check.py
@@ -78,7 +78,7 @@
 
 SCHEMA_VERSION = 1
 DLC_NAMESPACE = "deeplabcut"
-OUTPUT_FILENAME = "nb_docs_status"
+OUTPUT_FILENAME = "docs_nb_checks"
 DEFAULT_CFG = "docs_and_notebooks_report_config.yml"
 
 # -----------------------------
@@ -569,7 +569,7 @@ def parse_date_token(token: str) -> date:
 def main(argv: Optional[Sequence[str]] = None) -> int:
     parser = argparse.ArgumentParser(description="DeepLabCut checks tool (docs + notebooks)")
     parser.add_argument("--config", default=DEFAULT_CFG, help="Path to YAML config file")
-    parser.add_argument("--out-dir", default="tmp/docs_notebooks_status", help="Directory to write outputs")
+    parser.add_argument("--out-dir", default=f"tmp/{OUTPUT_FILENAME}", help="Directory to write outputs")
 
     sub = parser.add_subparsers(dest="cmd", required=True)
     sub.add_parser("report", help="Generate staleness report (read-only)")

diff --git a/.github/tools/docs_and_notebooks_tool_README.md b/.github/tools/docs_and_notebooks_tool_README.md
@@ -75,11 +75,13 @@ Writes:
 
 ### Check (read-only, may fail)
 
-`python .github/tools/docs_and_notebooks_check.py check`
-check only fails based on allowlists in tools/staleness_config.yml:
+Check only fails based on allowlists in tools/staleness_config.yml:
 
-require_metadata
+```
+python .github/tools/docs_and_notebooks_check.py check \
+require_metadata \
 require_recent_verification
+```
 
 By default these are empty, so CI will not fail.
 

diff --git a/.gitignore b/.gitignore
@@ -140,4 +140,4 @@ ENV/
 .mypy_cache/
 
 # Automated docs checks
-**/tmp/docs_notebooks_status/
+**/tmp/docs_nb_checks/