feat(docs): Update MapSwipe Docs

.github/workflows/pre-commit.yaml

@@ -18,19 +18,3 @@ jobs:
         uses: pre-commit/action@v3.0.1
         with:
           extra_args: --all-files --hook-stage manual --show-diff-on-failure
-
-      - name: Install lychee
-        run: |
-          mkdir ./lychee-install
-          cd ./lychee-install
-          curl -L https://github.com/lycheeverse/lychee/releases/latest/download/lychee-x86_64-unknown-linux-gnu.tar.gz -o lychee.tar.gz
-          tar -xzf lychee.tar.gz
-          mv lychee /usr/local/bin/
-          lychee --version
-          cd ../
-          rm -rf ./lychee-install
-
-      # TODO: Use pre-commit instead of this
-      - name: Run lychee
-        run: |
-          lychee --root-dir $(pwd)/ ./

.pre-commit-config.yaml

@@ -1,12 +1,11 @@
 repos:
-  # - repo: https://github.com/lycheeverse/lychee.git
-  #   rev: v0.15.1
-  #   hooks:
-  #     - id: lychee
-  #       args:
-  #         - "--no-progress"
-  #         - "."
-  #       pass_filenames: false
+  - repo: https://github.com/lycheeverse/lychee
+    rev: lychee-v0.24.1
+    hooks:
+      - id: lychee
+        files: \.md$
+        args: ["--no-progress", "--root-dir=.", "."]
+        pass_filenames: false
 
   - repo: https://github.com/crate-ci/typos
     rev: v1.31.1

pre-push.sh

@@ -24,16 +24,7 @@ if ! command -v pre-commit &>/dev/null; then
   exit 1
 fi
 
-if ! command -v lychee &>/dev/null; then
-  log_error "lychee is not installed."
-  log_error "Follow https://github.com/lycheeverse/lychee#installation"
-  exit 1
-fi
-
 echo "▶️ Running pre-commit"
 pre-commit run --color=always --all-files
 
-echo "▶️ Running lychee"
-lychee --root-dir $(pwd)/ ./
-
 log_success "✅ All good"

project_types/project_types.md

@@ -21,6 +21,10 @@ The MapSwipe backend now supports 6 **project types**. Each project type formula
 ## Data Model
 This way of formulating the overall crowdsourcing challenge and it's subcomponents shapes the **data model** we use.
 
+Below you can see the structure on the example of a Find Features project type. The project manager supplies a bounding polygon, which is then divided into multiple groups, which are in turn divided into multiple tasks. Results are always bound to a task and what a result means differs by project type.
+
+![](/assets/project_types/project_types/mapswipe_data_model.png)
+
 With the revamp, as a project manager you have to care about the project. The information you provide through the **Manager Dashboard** will be used to set up your project. You should provide the following information.
 
 ### Projects