Merge pull request #2 from mapswipe/feat/docs

feat(doc): Add MapSwipe documentations

Author: thenav56

.github/workflows/pre-commit.yaml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  pull_request:
+
+jobs:
+  pre_commit_checks:
+    name: Pre-Commit checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@main
+
+      - name: Install pre-commit and run
+        uses: pre-commit/[email protected]
+        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)/ ./

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.env

.lycheeignore

@@ -0,0 +1,2 @@
+https://slack.com/shortcuts/Ft09CHNNHZNX/8d0d6f7d69a1350a91b2ef33fc6d5704
+https://www.mdpi.com/2072-4292/8/10/859

.pre-commit-config.yaml

@@ -0,0 +1,42 @@
+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/crate-ci/typos
+    rev: v1.31.1
+    hooks:
+      - id: typos
+
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.9.1
+    hooks:
+      - id: commitizen
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-merge-conflict
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-json
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+        args: [--unsafe]
+      - id: debug-statements
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: detect-private-key
+      - id: name-tests-test
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.24.2
+    hooks:
+      - id: gitleaks

assets/docs/about_data/files/agg_results_-M56eeMCZ5VeOHjJN4Bx.csv.gz

@@ -0,0 +1,6 @@
+day,number_of_results,number_of_results_progress,cum_number_of_results,cum_number_of_results_progress,progress,cum_progress,number_of_users,number_of_new_users,cum_number_of_users,project_id
+2020-04-17,138387,138387,138387,138387,0.3121084182465257,0.3121084182465257,78,78,78,-M56eeMCZ5VeOHjJN4Bx
+2020-04-18,126825,126639,265212,265026,0.2856127958429749,0.5977212140895005,113,85,163,-M56eeMCZ5VeOHjJN4Bx
+2020-04-19,143178,137460,408390,402486,0.31001772689752227,0.9077389409870228,88,39,202,-M56eeMCZ5VeOHjJN4Bx
+2020-04-20,59640,40557,468030,443043,0.0914694380167526,0.9992083790037755,37,11,213,-M56eeMCZ5VeOHjJN4Bx
+2020-04-21,258,0,468288,443043,0.0,0.9992083790037755,1,0,213,-M56eeMCZ5VeOHjJN4Bx