fix: fix various invalid external URLs (#123)

tg73 · tg73 · commit ef425725c760 · 2026-03-01T18:00:52.000Z
* feat(scripts): add check-urls.py, a development-time script to scan for external URLs referenced in the repo and check validity

* fix(urls): fix various invalid external URLs, mostly links to documentation

* chore: fix typo

* chore: resolve heading level inconsistency
diff --git a/configuration/boards/ay-caramba/board-definition.json b/configuration/boards/ay-caramba/board-definition.json
@@ -7,7 +7,7 @@
 	"firmwareBinaryName": "firmware-caramba.bin",
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/ebb42-12",
+	"documentationLink": "https://os.ratrig.com/docs/toolboards/documentation-pending",
 	"fourPinFanConnectorCount": 1,
 	"disableAutoFlash": true,
 	"driverVoltages": [24],
diff --git a/configuration/boards/btt-ebb36-10/board-definition.json b/configuration/boards/btt-ebb36-10/board-definition.json
@@ -10,7 +10,7 @@
 	"firmwareBinaryName": "firmware-btt-ebb36-10.bin",
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/ebb36-10",
+	"documentationLink": "https://os.ratrig.com/docs/toolboards/btt/ebb-36-10",
 	"driverCount": 1,
 	"integratedDrivers": {
 		"extruder": "BTT-TMC2209-13"
diff --git a/configuration/boards/btt-ebb36-11/board-definition.json b/configuration/boards/btt-ebb36-11/board-definition.json
@@ -10,7 +10,7 @@
 	"firmwareBinaryName": "firmware-btt-ebb36-11.bin",
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/ebb36-11",
+	"documentationLink": "https://os.ratrig.com/docs/toolboards/btt/ebb-36-11",
 	"disableAutoFlash": true,
 	"driverCount": 1,
 	"integratedDrivers": {
diff --git a/configuration/boards/btt-ebb36-12/board-definition.json b/configuration/boards/btt-ebb36-12/board-definition.json
@@ -10,7 +10,7 @@
 	"firmwareBinaryName": "firmware-btt-ebb36-12.bin",
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/ebb36-12",
+	"documentationLink": "https://os.ratrig.com/docs/toolboards/btt/ebb-36-12",
 	"driverCount": 1,
 	"integratedDrivers": {
 		"extruder": "BTT-TMC2209-13"
diff --git a/configuration/boards/btt-ebb42-10/board-definition.json b/configuration/boards/btt-ebb42-10/board-definition.json
@@ -10,7 +10,7 @@
 	"firmwareBinaryName": "firmware-btt-ebb42-10.bin",
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/ebb42-10",
+	"documentationLink": "https://os.ratrig.com/docs/toolboards/btt/ebb-42-10",
 	"driverCount": 1,
 	"integratedDrivers": {
 		"extruder": "BTT-TMC2209-13"
diff --git a/configuration/boards/btt-ebb42-11/board-definition.json b/configuration/boards/btt-ebb42-11/board-definition.json
@@ -10,7 +10,7 @@
 	"firmwareBinaryName": "firmware-btt-ebb42-11.bin",
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/ebb42-11",
+	"documentationLink": "https://os.ratrig.com/docs/toolboards/btt/ebb-42-11",
 	"disableAutoFlash": true,
 	"driverCount": 1,
 	"integratedDrivers": {
diff --git a/configuration/boards/btt-ebb42-12/board-definition.json b/configuration/boards/btt-ebb42-12/board-definition.json
@@ -10,7 +10,7 @@
 	"firmwareBinaryName": "firmware-btt-ebb42-12.bin",
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/ebb42-12",
+	"documentationLink": "https://os.ratrig.com/docs/toolboards/btt/ebb-42-12",
 	"driverCount": 1,
 	"integratedDrivers": {
 		"extruder": "BTT-TMC2209-13"
diff --git a/configuration/boards/btt-ebb42-gen2-10/board-definition.json b/configuration/boards/btt-ebb42-gen2-10/board-definition.json
@@ -10,7 +10,7 @@
 	"firmwareBinaryName": "firmware-btt-ebb42-gen2-10.bin",
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/ebb42-12",
+	"documentationLink": "https://os.ratrig.com/docs/toolboards/documentation-pending",
 	"driverCount": 1,
 	"integratedDrivers": {
 		"extruder": "BTT-TMC2209-13"
diff --git a/configuration/boards/btt-manta-m4p-22/board-definition.json b/configuration/boards/btt-manta-m4p-22/board-definition.json
@@ -10,7 +10,7 @@
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
 	"flashInstructions": "Flashing only works if the SD card slot on the Manta is empty.",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/manta-m4p",
+	"documentationLink": "https://os.ratrig.com/docs/boards/btt/manta-m4p-22",
 	"driverCount": 4,
 	"driverVoltages": [24, 36, 48, 56],
 	"motorSlots": {
diff --git a/configuration/boards/btt-manta-m4p/board-definition.json b/configuration/boards/btt-manta-m4p/board-definition.json
@@ -10,7 +10,7 @@
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
 	"flashInstructions": "Flashing only works if the SD card slot on the Manta is empty.",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/manta-m4p",
+	"documentationLink": "https://os.ratrig.com/docs/boards/btt/manta-m4p-10",
 	"driverCount": 4,
 	"driverVoltages": [24, 36, 48, 56],
 	"motorSlots": {
diff --git a/configuration/boards/btt-octopus-pro-h723-11/board-definition.json b/configuration/boards/btt-octopus-pro-h723-11/board-definition.json
@@ -10,7 +10,7 @@
 	"compileScript": "compile.sh",
 	"flashScript": "flash.sh",
 	"flashInstructions": "Flashing only works if the SD card slot on the Octopus Pro is empty.",
-	"documentationLink": "https://os.ratrig.com/docs/boards/btt/octopus-pro-h723-11",
+	"documentationLink": "https://os.ratrig.com/docs/boards/btt/octopus-pro-h723",
 	"driverCount": 8,
 	"driverVoltages": [24, 36, 48, 56],
 	"dfu": {
diff --git a/configuration/klippy/beacon_mesh.py b/configuration/klippy/beacon_mesh.py
@@ -339,9 +339,9 @@ def auto_select_compensation_mesh(self, bed_temperature=None):
 		# Automatically selects a compensation mesh based on the specified bed_temperature, or the
 		# current target bed temperature if bed_temperature is None.
 
-		link_url = "https://os.ratrig.com/docs/configuration/beacon_contact"
+		link_url = "https://os.ratrig.com/docs/configuration/beacon"
 		link_text = "Beacon Contact Compensation Mesh"
-		link_line = f'Lean more about <a href="{link_url}" target="_blank">{link_text}</a>'
+		link_line = f'Learn more about <a href="{link_url}" target="_blank">{link_text}</a>'
 
 		profiles = self.get_profiles(RATOS_MESH_KIND_COMPENSATION)
 
diff --git a/configuration/macros.cfg b/configuration/macros.cfg
@@ -273,7 +273,7 @@ gcode:
 #####
 # START PRINT MACROS
 # Call this from your slicer (custom g-code). 
-# Read more here: https://rat-rig.github.io/V-CoreOS/#/slicers
+# Read more here: https://os.ratrig.com/docs/slicers
 #####
 [gcode_macro START_PRINT]
 description: Start print procedure, use this in your Slicer.
@@ -1248,7 +1248,7 @@ gcode:
 #####
 # END PRINT MACROS
 # Call this from your slicer (custom g-code). 
-# Read more here: https://rat-rig.github.io/V-CoreOS/#/slicers
+# Read more here: https://os.ratrig.com/docs/slicers
 #####
 # The end_print macro is also called from CANCEL_PRINT.
 [gcode_macro END_PRINT]
diff --git a/configuration/printers/v-core-3-idex/macros.cfg b/configuration/printers/v-core-3-idex/macros.cfg
@@ -22,7 +22,7 @@ gcode:
 
 # Print macros. Call these from your slicer (custom g-code). 
 # You can copy these to printer.cfg and modify them to your liking, or just use them as is.
-# Read more here: https://rat-rig.github.io/V-CoreOS/#/slicers
+# Read more here: https://os.ratrig.com/docs/slicers
 
 # Macro to perform a modified z_tilt supporting stowable probes
 [gcode_macro Z_TILT_ADJUST]
diff --git a/configuration/printers/v-core-3/macros.cfg b/configuration/printers/v-core-3/macros.cfg
@@ -4,7 +4,7 @@
 
 # Print macros. Call these from your slicer (custom g-code). 
 # You can copy these to printer.cfg and modify them to your liking, or just use them as is.
-# Read more here: https://rat-rig.github.io/V-CoreOS/#/slicers
+# Read more here: https://os.ratrig.com/docs/slicers
 # Macro to perform a modified z_tilt supporting stowable probes
 
 [gcode_macro Z_TILT_ADJUST]
diff --git a/scripts/README.md b/scripts/README.md
@@ -2,9 +2,7 @@
 
 This directory contains standalone utility scripts for the RatOS-configurator project.
 
-## Available Scripts
-
-### `validate-bash-syntax.sh`
+## `validate-bash-syntax.sh`
 
 A comprehensive bash script syntax validation tool with parallel processing for optimal performance.
 
@@ -153,3 +151,8 @@ When adding new utility scripts to this directory:
 # Test specific script
 bash -n ./scripts/your-script.sh
 ```
+
+## `check-urls.py`
+A Python script that scans the repository for HTTP/HTTPS URLs and verifies their reachability, with support for exclusions and parallel processing. This is useful for ensuring that all external links in documentation, code comments, and configuration files remain valid and accessible.
+
+Best run from a vscode terminal, as you can then click on the detected URLs and file references in the output.
diff --git a/scripts/check-urls.py b/scripts/check-urls.py
