fix: fix pre-commit issues

tnagorra · tnagorra · commit 413625cc9932 · 2026-05-18T08:51:47.000+05:45
- use relative file links
- add jekyll-relative-links plugin
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,7 +4,13 @@ repos:
     hooks:
       - id: lychee
         files: \.md$
-        args: ["--no-progress", "--root-dir=.", "."]
+        args:
+          - "--no-progress"
+          - "--root-dir=."
+          - "--exclude-path=_includes"
+          - "--exclude-path=_layouts"
+          - "--exclude-path=_site"
+          - "."
         pass_filenames: false
 
   - repo: https://github.com/crate-ci/typos
diff --git a/_config.yml b/_config.yml
@@ -12,6 +12,14 @@ plugins:
   - jekyll-seo-tag
   - jekyll-sitemap
   - jekyll-toc
+  - jekyll-relative-links
+
+# Rewrite Markdown links to *.md files into their rendered permalinks at build
+# time. Lets us author plain relative .md links (which lychee can verify on
+# disk) instead of hand-maintaining permalink URLs.
+relative_links:
+  enabled: true
+  collections: false
 
 # Markdown processor (jekyll-commonmark-ghpages)
 markdown: CommonMarkGhPages
diff --git a/assets/docs/about_data/files/global_exports/projects.csv b/assets/docs/about_data/files/global_exports/projects.csv
diff --git a/assets/docs/about_data/files/global_exports/projects_centroid.geojson b/assets/docs/about_data/files/global_exports/projects_centroid.geojson
@@ -313,4 +313,4 @@
       }
     }
   ]
-}
+}
diff --git a/assets/docs/about_data/files/global_exports/projects_geom.geojson b/assets/docs/about_data/files/global_exports/projects_geom.geojson
@@ -9468,4 +9468,4 @@
       }
     }
   ]
-}
+}
diff --git a/assets/docs/about_data/files/project_exports/agg_results_by_task_2962_geom.geojson b/assets/docs/about_data/files/project_exports/agg_results_by_task_2962_geom.geojson
@@ -543,4 +543,4 @@
       }
     }
   ]
-}
+}
diff --git a/assets/docs/about_data/files/project_exports/hot_tm_2962.geojson b/assets/docs/about_data/files/project_exports/hot_tm_2962.geojson
@@ -389,4 +389,4 @@
       }
     }
   ]
-}
+}
diff --git a/assets/docs/about_data/files/project_exports/yes_maybe_2962.geojson b/assets/docs/about_data/files/project_exports/yes_maybe_2962.geojson
@@ -1229,4 +1229,4 @@
       }
     }
   ]
-}
+}
diff --git a/docs/about_data.md b/docs/about_data.md
@@ -15,23 +15,23 @@ Swiping is just the beginning. MapSwipe data is created by our users and accessi
 ## Global Exports
 Exports that describe the whole MapSwipe project catalog.
 
-- [Projects Overview](/docs/about_data/projects/) (`projects.csv`) — every project in MapSwipe, one row per project.
-- [Projects with Geometry](/docs/about_data/projects_geom/) (`projects_geom.geojson`) — project metadata + each project's area-of-interest polygon(s).
-- [Projects with Centroid](/docs/about_data/projects_centroid/) (`projects_centroid.geojson`) — same metadata but with a single centroid point per project.
-- [Project Type's Stats](/docs/about_data/project_stats_by_types/) (`project_stats_by_types.csv`) — aggregated stats grouped by project type.
+- [Projects Overview](about_data/projects.md) (`projects.csv`) — every project in MapSwipe, one row per project.
+- [Projects with Geometry](about_data/projects_geom.md) (`projects_geom.geojson`) — project metadata + each project's area-of-interest polygon(s).
+- [Projects with Centroid](about_data/projects_centroid.md) (`projects_centroid.geojson`) — same metadata but with a single centroid point per project.
+- [Project Type's Stats](about_data/project_stats_by_types.md) (`project_stats_by_types.csv`) — aggregated stats grouped by project type.
 
 ## Project Specific Exports
 Exports scoped to a single project. For the examples on the following pages we use:
 
 > *Find Features - Find Buildings - Mozambique Floods 2026 - Chibuto (1) HOT — `id` `2962`, `firebaseId` `01KMMX0C9MG396SCV8W8CZ8RY3`*
 
-- [Aggregated Results](/docs/about_data/aggregated_results/) — unfiltered MapSwipe results aggregated on the task level (CSV).
-- [Aggregated Results (with Geometry)](/docs/about_data/aggregated_results_with_geometry/) — same data as Aggregated Results, delivered as a GeoJSON `FeatureCollection`.
-- [Groups](/docs/about_data/groups/) — task groups and their progress.
-- [History](/docs/about_data/history/) — daily activity timeline.
-- [Results](/docs/about_data/results/) — individual user contributions per task.
-- [Tasks](/docs/about_data/tasks/) — task identifiers and geometries.
-- [Users](/docs/about_data/users/) — contributor stats for this project.
-- [Area of Interest](/docs/about_data/area_of_interest/) — the project's region as GeoJSON.
-- [HOT Tasking Manager Geometries](/docs/about_data/hot_tm/) — filtered geometries ready for import into HOT Tasking Manager.
-- [Moderate to High Agreement Yes Maybe Geometries](/docs/about_data/yes_maybe/) — merged polygons of areas marked yes / maybe.
+- [Aggregated Results](about_data/aggregated_results.md) — unfiltered MapSwipe results aggregated on the task level (CSV).
+- [Aggregated Results (with Geometry)](about_data/aggregated_results_with_geometry.md) — same data as Aggregated Results, delivered as a GeoJSON `FeatureCollection`.
+- [Groups](about_data/groups.md) — task groups and their progress.
+- [History](about_data/history.md) — daily activity timeline.
+- [Results](about_data/results.md) — individual user contributions per task.
+- [Tasks](about_data/tasks.md) — task identifiers and geometries.
+- [Users](about_data/users.md) — contributor stats for this project.
+- [Area of Interest](about_data/area_of_interest.md) — the project's region as GeoJSON.
+- [HOT Tasking Manager Geometries](about_data/hot_tm.md) — filtered geometries ready for import into HOT Tasking Manager.
+- [Moderate to High Agreement Yes Maybe Geometries](about_data/yes_maybe.md) — merged polygons of areas marked yes / maybe.
diff --git a/docs/about_data/aggregated_results.md b/docs/about_data/aggregated_results.md
@@ -6,7 +6,7 @@ permalink: /docs/about_data/aggregated_results/
 ---
 
 # Aggregated Results
-This gives you the unfiltered MapSwipe results aggregated on the task level. This is most suited if you want to apply some custom data processing with the MapSwipe data, e.g. select only specific tasks. If you want geometries on each task instead of a `geom` column, see [Aggregated Results (with Geometry)](/docs/about_data/aggregated_results_with_geometry/).
+This gives you the unfiltered MapSwipe results aggregated on the task level. This is most suited if you want to apply some custom data processing with the MapSwipe data, e.g. select only specific tasks. If you want geometries on each task instead of a `geom` column, see [Aggregated Results (with Geometry)](aggregated_results_with_geometry.md).
 
 ## Schema
 
diff --git a/docs/about_data/aggregated_results_with_geometry.md b/docs/about_data/aggregated_results_with_geometry.md
@@ -6,11 +6,11 @@ permalink: /docs/about_data/aggregated_results_with_geometry/
 ---
 
 # Aggregated Results (with Geometry)
-Same task-level aggregation as [Aggregated Results](/docs/about_data/aggregated_results/), but delivered as a GeoJSON `FeatureCollection` — the task polygon lives on each feature's `geometry` instead of being a WKT column.
+Same task-level aggregation as [Aggregated Results](aggregated_results.md), but delivered as a GeoJSON `FeatureCollection` — the task polygon lives on each feature's `geometry` instead of being a WKT column.
 
 ## Schema
 
-One feature per task. Property names match [Aggregated Results](/docs/about_data/aggregated_results/) minus `geom` (the geometry is on the feature itself). Each feature's `geometry` is a `MultiPolygon` (EPSG:4326).
+One feature per task. Property names match [Aggregated Results](aggregated_results.md) minus `geom` (the geometry is on the feature itself). Each feature's `geometry` is a `MultiPolygon` (EPSG:4326).
 
 ## Sample download
 
diff --git a/docs/about_data/projects_centroid.md b/docs/about_data/projects_centroid.md
@@ -6,7 +6,7 @@ permalink: /docs/about_data/projects_centroid/
 ---
 
 # Projects with Centroid
-Same `FeatureCollection` and property schema as [Projects with Geometry](/docs/about_data/projects_geom/), but each feature's `geometry` is a single `Point` (the project centroid) instead of a `GeometryCollection` of polygons. Use this when you want a lightweight overview map without the full project boundaries.
+Same `FeatureCollection` and property schema as [Projects with Geometry](projects_geom.md), but each feature's `geometry` is a single `Point` (the project centroid) instead of a `GeometryCollection` of polygons. Use this when you want a lightweight overview map without the full project boundaries.
 
 ## Sample download
 
diff --git a/docs/for_project_managers.md b/docs/for_project_managers.md
@@ -10,10 +10,10 @@ permalink: /docs/for_project_managers/
 
 Reference for MapSwipe project managers — how to obtain manager access, how to create projects and tutorials, and how the manager dashboard's directory pages (Organisations, Managers, Contributors, User Groups, Teams) are structured.
 
-- [Managers](/docs/for_project_managers/managers/) — the manager directory, plus how to become a manager, sign in, and revoke access.
-- [Projects](/docs/for_project_managers/projects/) — creating, processing, and publishing MapSwipe projects.
-- [Tutorials](/docs/for_project_managers/tutorials/) — creating and managing project tutorials.
-- [User Groups](/docs/for_project_managers/user_groups/) — community-managed groups contributors can join.
-- [Contributors](/docs/for_project_managers/contributors/) — MapSwipe app users who contribute results.
-- [Organisations](/docs/for_project_managers/organisations/) — the requesting organisations behind each project.
-- [Teams](/docs/for_project_managers/teams/) — private teams managed by the super admin.
+- [Managers](for_project_managers/managers.md) — the manager directory, plus how to become a manager, sign in, and revoke access.
+- [Projects](for_project_managers/projects.md) — creating, processing, and publishing MapSwipe projects.
+- [Tutorials](for_project_managers/tutorials.md) — creating and managing project tutorials.
+- [User Groups](for_project_managers/user_groups.md) — community-managed groups contributors can join.
+- [Contributors](for_project_managers/contributors.md) — MapSwipe app users who contribute results.
+- [Organisations](for_project_managers/organisations.md) — the requesting organisations behind each project.
+- [Teams](for_project_managers/teams.md) — private teams managed by the super admin.
diff --git a/docs/for_project_managers/projects.md b/docs/for_project_managers/projects.md
@@ -55,7 +55,7 @@ At a glance, the end-to-end flow looks like:
     - You can edit it as needed; however, the project type is locked at this stage.
 - Fields under the **Additional** section come with default values that can be edited.
     - Upload a project cover image, or the default cover for the project type will be used.
-- Fill in the **Project type specific details** section. The form changes per project type — see the [Project Types](/project_types/) docs for each type's exact fields.
+- Fill in the **Project type specific details** section. The form changes per project type — see the [Project Types](../project_types.md) docs for each type's exact fields.
 - Save the project.
 - Once saved, submit the project for processing to move to the next stage.
 
@@ -72,7 +72,7 @@ At a glance, the end-to-end flow looks like:
 - The **General**, **Additional**, and **Project type specific details** sections are now populated.
     - You can update the general information and the project cover image.
 - Attach a tutorial of the matching project type from the list of options.
-    - If no suitable tutorial exists, or the project needs a custom tutorial, [create the tutorial first](/docs/for_project_managers/tutorials/#creating-a-tutorial) and come back to continue project creation.
+    - If no suitable tutorial exists, or the project needs a custom tutorial, [create the tutorial first](./tutorials.md#creating-a-tutorial) and come back to continue project creation.
 - Save the updated project, then publish it.
 
 ### Publishing
diff --git a/docs/overview.md b/docs/overview.md
@@ -6,7 +6,7 @@ permalink: /docs/overview/
 
 # MapSwipe Overview
 
-This page walks through the typical MapSwipe workflow, from a project manager setting up a project through to volunteers contributing results and the data being exported. For how the underlying components fit together, see [System Architecture](/docs/system_architecture/).
+This page walks through the typical MapSwipe workflow, from a project manager setting up a project through to volunteers contributing results and the data being exported. For how the underlying components fit together, see [System Architecture](system_architecture.md).
 
 ## A typical MapSwipe workflow
 
diff --git a/docs/project_types.md b/docs/project_types.md
@@ -15,12 +15,12 @@ The MapSwipe crowdsourcing workflow is designed following an approach already pr
 
 The MapSwipe backend now supports 6 **project types**. Each project type formulates a specific kind of mapping challenge — follow the links for a description, screenshot, and data model details for each one.
 
-- [Find Features](/docs/project_types/find_features)
-- [Validate Footprints](/docs/project_types/validate_footprints)
-- [Compare Dates](/docs/project_types/compare_dates)
-- [Assess Images](/docs/project_types/assess_images)
-- [Check Completeness](/docs/project_types/check_completeness)
-- [View Streets](/docs/project_types/view_streets)
+- [Find Features](project_types/find_features.md)
+- [Validate Footprints](project_types/validate_footprints.md)
+- [Compare Dates](project_types/compare_dates.md)
+- [Assess Images](project_types/assess_images.md)
+- [Check Completeness](project_types/check_completeness.md)
+- [View Streets](project_types/view_streets.md)
 
 
 ## Data Model
diff --git a/docs/project_types/assess_images.md b/docs/project_types/assess_images.md
@@ -21,14 +21,14 @@ To build a COCO file from a folder of images you already host, see the helper ex
 ## Project
 Assess Images projects can be supplied with a COCO file.
 
-In addition to the common project fields documented in the [data model](/project_types/), Assess Images projects carry the following project-type-specific fields:
+In addition to the common project fields documented in the [data model](../project_types.md), Assess Images projects carry the following project-type-specific fields:
 
 | Parameter         | Type            | Description                                                                                                                                                              |
 |-------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **customOptions** | list (optional) | Custom answer options shown to the contributor (each with a value, title, description, icon, iconColor, and optional sub-options). Defaults are Yes/No when not supplied. |
 
 ## Group
-Each group contains a set of image tasks generated from the supplied COCO file. Assess Images groups have no project-type-specific fields beyond the [common group fields](/project_types/#groups). Each group is identified by:
+Each group contains a set of image tasks generated from the supplied COCO file. Assess Images groups have no project-type-specific fields beyond the [common group fields](../project_types.md#groups). Each group is identified by:
 
 | Parameter   | Type   | Description       |
 |-------------|--------|-------------------|
@@ -49,7 +49,7 @@ The task structure of the Assess Images project type varies from the rest — ea
 | **segmentation** | `list[list[float]]` (optional) | Optional polygon segmentation (list of `[x, y, …]` rings) from the COCO annotation.  |
 
 ## Result
-Results follow the [common result shape](/project_types/#results), with `results: dict[str, int]` keyed by `taskId`. The integer values come from each custom option's `value` defined on the project.
+Results follow the [common result shape](../project_types.md#results), with `results: dict[str, int]` keyed by `taskId`. The integer values come from each custom option's `value` defined on the project.
 
 When the project creator does not supply `customOptions`, the backend falls back to the following defaults:
 
diff --git a/docs/project_types/check_completeness.md b/docs/project_types/check_completeness.md
@@ -18,7 +18,7 @@ Check Completeness projects have `projectType = 4`.
 ## Project
 The structure and creation steps follow the similar pattern of the Find Features project type.
 
-In addition to the common project fields documented in the [data model](/project_types/), Check Completeness projects carry the following project-type-specific fields:
+In addition to the common project fields documented in the [data model](../project_types.md), Check Completeness projects carry the following project-type-specific fields:
 
 | Parameter              | Type   | Description                                                                                                                                                |
 |------------------------|--------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -48,7 +48,7 @@ Tasks are saved for tutorials, since their spatial information can be derived fr
 | **url**      | string | The tile URL points to the specific tile image described by the x, y, and z coordinates. Usually, the image has a resolution of 256 x 256 pixels. However, some providers also generate image tiles with higher resolution (e.g. 512 x 512 pixels).                                                                                                                                    |
 
 ## Result
-Results follow the [common result shape](/project_types/#results), with `results: dict[str, int]` keyed by `taskId`. Only the following classifications are stored:
+Results follow the [common result shape](../project_types.md#results), with `results: dict[str, int]` keyed by `taskId`. Only the following classifications are stored:
 
 | Value | Meaning     |
 |-------|-------------|
diff --git a/docs/project_types/compare_dates.md b/docs/project_types/compare_dates.md
@@ -16,7 +16,7 @@ Compare Dates projects have `projectType = 3`.
 ## Project
 The structure and creation steps follow the similar pattern of the Find Features project type. Projects can also be created via a HOT Tasking Manager Project ID.
 
-In addition to the common project fields documented in the [data model](/project_types/), Compare Dates projects carry the following project-type-specific fields:
+In addition to the common project fields documented in the [data model](../project_types.md), Compare Dates projects carry the following project-type-specific fields:
 
 | Parameter       | Type   | Description                                                                                                                                |
 |-----------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------|
@@ -45,7 +45,7 @@ Compare Dates groups carry tile-map-service bounding-box tile coordinates on top
 | **urlB**     | string (optional) | Image for the tile after timestamp A. The tile URL points to the specific tile image described by the x, y, and z coordinates.                                                                                                                                                                                                                                                         |
 
 ## Result
-Results follow the [common result shape](/project_types/#results), with `results: dict[str, int]` keyed by `taskId`. Only the following classifications are stored:
+Results follow the [common result shape](../project_types.md#results), with `results: dict[str, int]` keyed by `taskId`. Only the following classifications are stored:
 
 | Value | Meaning     |
 |-------|-------------|
diff --git a/docs/project_types/find_features.md b/docs/project_types/find_features.md
@@ -16,7 +16,7 @@ Find Features projects have `projectType = 1`.
 ## Project
 To create a Find Features project, you need to add all information and upload a bounding polygon as well as fill in some information about your project.
 
-In addition to the common project fields documented in the [data model](/project_types/), Find Features projects carry the following project-type-specific fields:
+In addition to the common project fields documented in the [data model](../project_types.md), Find Features projects carry the following project-type-specific fields:
 
 | Parameter      | Type   | Description                                                                                                |
 |----------------|--------|------------------------------------------------------------------------------------------------------------|
@@ -47,7 +47,7 @@ Tasks are saved for tutorials, since their spatial information can be derived fr
 | **url**      | string | The tile URL points to the specific tile image described by the x, y, and z coordinates. Usually, the image has a resolution of 256 x 256 pixels. However, some providers also generate image tiles with higher resolution (e.g. 512 x 512 pixels).                                                                                                                                    |
 
 ## Result
-Results follow the [common result shape](/project_types/#results), with `results: dict[str, int]` keyed by `taskId`. The integer encoding for Find Features is:
+Results follow the [common result shape](../project_types.md#results), with `results: dict[str, int]` keyed by `taskId`. The integer encoding for Find Features is:
 
 | Value | Meaning      |
 |-------|--------------|
diff --git a/docs/project_types/validate_footprints.md b/docs/project_types/validate_footprints.md
diff --git a/docs/project_types/view_streets.md b/docs/project_types/view_streets.md
diff --git a/examples/generate-coco-from-drive/README.md b/examples/generate-coco-from-drive/README.md
diff --git a/examples/generate-coco-from-dropbox/README.md b/examples/generate-coco-from-dropbox/README.md
diff --git a/examples/generate-coco-from-dropbox/generate_coco_from_dropbox.py b/examples/generate-coco-from-dropbox/generate_coco_from_dropbox.py
diff --git a/index.md b/index.md

Original file line number	Diff line number	Diff line change
`@@ -313,4 +313,4 @@`
`313`	`313`	`}`
`314`	`314`	`}`
`315`	`315`	`]`
`316`		`-}`
	`316`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -9468,4 +9468,4 @@`
`9468`	`9468`	`}`
`9469`	`9469`	`}`
`9470`	`9470`	`]`
`9471`		`-}`
	`9471`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -543,4 +543,4 @@`
`543`	`543`	`}`
`544`	`544`	`}`
`545`	`545`	`]`
`546`		`-}`
	`546`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -389,4 +389,4 @@`
`389`	`389`	`}`
`390`	`390`	`}`
`391`	`391`	`]`
`392`		`-}`
	`392`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1229,4 +1229,4 @@`
`1229`	`1229`	`}`
`1230`	`1230`	`}`
`1231`	`1231`	`]`
`1232`		`-}`
	`1232`	`+}`