Merge pull request #14 from AristurtleDev/feature/link-errors

Treat Invalid Links as Errors

Author: SimonDarksideJ

.github/workflows/pullrequest.yml

@@ -25,6 +25,8 @@ jobs:
     steps:
       - name: Clone Repository
         uses: actions/checkout@v4
+        with:
+          submodules: recursive
 
       - name: Setup .NET SDK
         uses: actions/setup-dotnet@v4

api/index.md

@@ -7,4 +7,4 @@ Welcome to the **MonoGame** reference documentation!
 
 This area provides detailed information on each class and method in the API.
 
-Please view the [documentation](../articles/) for how to get started and step-by-step guidance.
+Please view the [documentation](../articles/index.md) for how to get started and step-by-step guidance.

articles/toc.yml

@@ -67,4 +67,4 @@
 - name: Help and Support
   href: help_and_support.md
 - name: Contributing to documentation
-  href: contributing
+  href: contributing.md

docfx.json

@@ -19,6 +19,12 @@
       "EnumSortOrder": "alphabetic"
     }
   ],
+  "rules": {
+    "InvalidFileLink": "error",
+    "InvalidBookmark": "error",
+    "UidNotFound": "error",
+    "ReferencedXrefPropertyNotString": "error"
+  },  
   "build": {
     "content": [
       {
@@ -34,7 +40,8 @@
           "foundation/**/*.md",
           "toc.yml",
           "*.md"
-        ]
+        ],
+        "exclude": [ "_site/**", "README.md" ]
       }
     ],
     "resource": [