add workflow to check that all .md files are linked in SUMMARY.md (#518)

Author: slarticodefast

.github/workflows/test-summary.yml

@@ -0,0 +1,14 @@
+name: Test SUMMARY.md
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  test-summary:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+    - name: Run SUMMARY.md link check
+      run: python tests/test_summary.py

src/SUMMARY.md

@@ -123,6 +123,7 @@ Space Station 14
 	- [Device Network](en/space-station-14/core-tech/device-network.md)
 	- [NPCs](en/space-station-14/core-tech/npcs.md)
 	- [Entity Tables](en/space-station-14/core-tech/entity-tables.md)
+	- [Body](en/space-station-14/core-tech/body.md)
 	- [Chemistry](en/space-station-14/core-tech/chemistry.md)
 		- [Metabolism](en/space-station-14/core-tech/chemistry/metabolism.md)
 		- [Reactions](en/space-station-14/core-tech/chemistry/reactions.md)
@@ -150,6 +151,7 @@ Space Station 14
 	- [PR Guidelines](en/space-station-14/character-species/guidelines.md)
 		
 	- [Proposals]()
+		- [Vulpkanin](en/space-station-14/character-species/proposals/vulpkanin.md)
 
 - [Combat](en/space-station-14/combat.md)
 	- [PR Guidelines](en/space-station-14/combat/guidelines.md)
@@ -206,13 +208,16 @@ Space Station 14
 		
 	- [Proposals]()
 		- [Stat Panels](en/space-station-14/user-interface/proposals/statpanels.md)
+		- [Playtime Reminders](en/space-station-14/user-interface/proposals/playtimereminders.md)
 - [Departments](en/space-station-14/departments.md)
 	- [Atmos](en/space-station-14/departments/atmos.md)
 		- [PR Guidelines](en/space-station-14/departments/atmos/guidelines.md)
 
 		- [Proposals]()
 			- [Atmos Rework](en/space-station-14/departments/atmos/proposals/atmos-rework.md)
 			- [Station Air Recirculation](en/space-station-14/departments/atmos/proposals/station-air-recirculation.md)
+			- [Inverse Pneumatic Valves](en/space-station-14/departments/atmos/proposals/inverse-pneumatic-valves.md)
+
 
 	- [Cargo](en/space-station-14/departments/cargo.md)
 		- [PR Guidelines](en/space-station-14/departments/cargo/guidelines.md)
@@ -255,6 +260,7 @@ Space Station 14
 		- [Proposals]()
 			- [GenPop Prisoners](en/space-station-14/departments/security/proposals/genpop-prisoners.md)
 			- [Reduced Metagaming Mechanics](en/space-station-14/departments/security/proposals/reduced-metagaming.md)
+			- [Secdog Unit Ghost role](en/space-station-14/departments/security/proposals/SecDog.md)
 	- [Service](en/space-station-14/departments/service.md)
 		- [PR Guidelines](en/space-station-14/departments/service/guidelines.md)
 

src/en/space-station-14/departments/engineering/proposals/inverse-pneumatic-valves.md renamed to src/en/space-station-14/departments/atmos/proposals/inverse-pneumatic-valves.md

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+
+import re
+import sys
+from pathlib import Path
+
+REPO_ROOT = Path.cwd()
+
+# Folders to check
+DOCS_DIRS = [
+    REPO_ROOT / r"src/en",
+]
+
+# Folders to ignore
+EXEMPT_DIRS = [
+    REPO_ROOT / r"src/en/assets",
+    REPO_ROOT / r"src/en/templates",
+]
+
+# The file to check the links for
+SUMMARY_FILE = REPO_ROOT / r"src/SUMMARY.md"
+
+
+def get_summary_links():
+    """Parse SUMMARY.md and return set of linked md paths (absolute)."""
+    links = set()
+    # regex explanation:
+    # valid links have the form
+    # [How do I code?](en/general-development/setup/howdoicode.md)
+    # \[ and \] match literal brackets
+    # [^]] means "not a closing bracket"
+    # [^]]+ matches the text inside the brackets, with at least one character
+    # \( and \) match literal parenthesis
+    # [^)] means "not a closing parentheses"
+    # [^)]+ matches the file link, with at least one character
+    # ([^)]+) will capture the file link inside the parentheses
+    link_pattern = re.compile(r"\[[^]]+\]\(([^)]+)\)")
+
+    for line in SUMMARY_FILE.read_text(encoding="utf-8").splitlines():
+        match = link_pattern.search(line)
+        if match:
+            path = match.group(1)
+            absolute = (SUMMARY_FILE.parent / path).resolve()
+            links.add(absolute)
+
+    return links
+
+
+def get_all_docs(folder: Path):
+    """Collect all .md files in the given folder, skipping exempt folders."""
+    exempt_resolved = [ex.resolve() for ex in EXEMPT_DIRS]
+
+    docs = set()
+    for p in folder.rglob("*.md"):
+        # Skip exempt dirs
+        if any(ex in p.resolve().parents for ex in exempt_resolved):
+            continue
+        docs.add(p.resolve())
+
+    return docs
+
+
+def main() -> int:
+    summary_links = get_summary_links()
+    missing_any = False
+
+    for docs_dir in DOCS_DIRS:
+        docs = get_all_docs(docs_dir)
+        print(f"found {len(docs)} .md files in {docs_dir}")
+        missing = [d for d in docs if d not in summary_links]
+
+        if missing:
+            print(f"❌ The following docs in {docs_dir} are not linked in SUMMARY.md:")
+            for m in missing:
+                print(" -", m.relative_to(Path.cwd()))
+            missing_any = True
+        else:
+            print(f"✅ All docs in {docs_dir} are linked in SUMMARY.md")
+
+    return 1 if missing_any else 0
+
+exit(main())