add consensus to docs

.github/workflows/build_mkdocs.yml

@@ -1,15 +1,20 @@
-name: Deploy MkDocs to GitHub Pages 
+name: Build and deploy MkDocs to GitHub Pages 
 
 on:
+  pull_request:
+    # Test build for PRs targeting default branch
+    branches:
+      - native
   push:
+    # Deploy on push to default branch
     branches:
       - native
 
 permissions:
   contents: write
 
 jobs:
-  deploy:
+  build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -20,5 +25,13 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r docs/requirements.txt
-      - name: Build and deploy MkDocs
+
+      - name: Build MkDocs site (strict)
+        # Test build on PR to native branch
+        if: github.event_name == 'pull_request'
+        run: mkdocs build --strict
+
+      - name: Deploy to GitHub Pages
+        # Deploy on push to native branch
+        if: github.event_name == 'push' && github.ref == 'refs/heads/native'
         run: mkdocs gh-deploy --force

docs/modules/consensus.md

@@ -0,0 +1 @@
+../../consensus/README.md

docs/modules/index.md

@@ -5,9 +5,10 @@ The Spacehack 2.0 workflow consists of multiple module types:
 - [Datasets](data.md) to analyze
 - [Methods](method.md) to identify spatial doamins
 - [Metrics](metric.md) to evaluate performance against a groundtruth
+- [Consensus](consensus.md) to build a consensus clustering across multiple methods
 
 If you want to generate a new module you have to make sure to follow the format and 
 specification as defined in their respective sections. 
-Also, it might be worth having a look at the [Contribution guide](../contributing.md).
+Also, it might be worth having a look at the [Contribution guide](../CONTRIBUTING.md).
 
 ![Workflow](../img/workflow.svg)

mkdocs.yml

@@ -11,7 +11,8 @@ nav:
     - Data: modules/data.md
     - Method: modules/method.md
     - Metric: modules/metric.md
-  - Extending & Contributing: contributing.md
+    - Consensus: modules/consensus.md
+  - Extending & Contributing: CONTRIBUTING.md
   - About:
     - SpaceHack: https://spatialhackathon.github.io/
     - Repository: https://github.com/SpatialHackathon/SACCELERATOR