Merge branch 'master' into patch-1

opengisch · Jul 17, 2024 · ca21d83 · ca21d83
2 parents 943be92 + 7e9b5ee
commit ca21d83
Show file tree

Hide file tree

Showing 171 changed files with 2,395 additions and 556 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -1,32 +1,35 @@
 name: gh-pages
 
 on:
+  pull_request:
+    branches:
+      - master
   push:
     branches:
       - master
   schedule:
     - cron: '30 1 * * *'
   workflow_dispatch:
 
-permissions:
-  contents: write
-
 jobs:
   translations:
     runs-on: ubuntu-latest
     if: (github.event_name == 'schedule' && github.repository == 'opengisch/QField-docs') || (github.event_name != 'schedule')
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v3
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.10'
+          cache: 'pip'
 
       - name: Install Python requirements
-        run: pip install -r requirements.txt
+        run: |
+          pip install -r requirements.txt
+          pip install -r requirements-dev.txt
 
       - name: Install Python requirements insiders
         run: pip install -r requirements-insiders.txt
@@ -35,36 +38,57 @@ jobs:
 
       - name: Install Transifex client
         run: |
-          curl -OL https://github.com/transifex/cli/releases/download/v1.3.1/tx-linux-amd64.tar.gz
+          curl -OL https://github.com/transifex/cli/releases/download/v1.6.10/tx-linux-amd64.tar.gz
           tar -xvzf tx-linux-amd64.tar.gz
 
+      - name: Extract translatable content from mkdocs.yml config
+        run: ./utils/mkdocs_tx.py create_source
+
       - name: Configure Transifex
-        run: |
-          python ./utils/transifex_utils.py
+        run: ./utils/transifex_utils.py
         env:
           TX_TOKEN: ${{ secrets.TX_TOKEN }}
 
       - name: Push source files to Transifex
-        run: |
-          ./tx push
+        if: contains(fromJSON('["push", "workflow_dispatch", "schedule"]'), github.event_name)
+        run: ./tx push
         env:
           TX_TOKEN: ${{ secrets.TX_TOKEN }}
 
+      - name: Get all languages
+        id: get_langs
+        uses: mikefarah/[email protected]
+        with:
+          cmd: yq '.plugins[] | .i18n.languages | select( . != null ) | map(.locale) | join(",")' mkdocs.yml
+
       - name: Pull translations from Transifex
+        if: contains(fromJSON('["push", "workflow_dispatch", "schedule"]'), github.event_name) || ${{ github.event_name == 'pull_request' && github.repository == 'opengisch/QField-docs' }}
         run: |
-          ./tx pull -t -l en,de,fr,it,es,zh
+          ./tx pull -t -l ${{ steps.get_langs.outputs.result }}
           ./tx status
         env:
           TX_TOKEN: ${{ secrets.TX_TOKEN }}
 
+      - name: Translate Mkdocs config
+        if: contains(fromJSON('["push", "workflow_dispatch", "schedule"]'), github.event_name) || ${{ github.event_name == 'pull_request' && github.repository == 'opengisch/QField-docs' }}
+        run: |
+          ./utils/mkdocs_tx.py -s en update_config
+          ./utils/mkdocs_tx_commit.sh
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Build documentation
         run: mkdocs build
         env:
           DEFAULT_LANGUAGE_ONLY: false
 
-      - name: Deploy to GitHub Pages
-        uses: JamesIves/github[email protected]
+      - uses: actions/upload-artifact@v4
+        if: ${{ github.event_name == 'pull_request' }}
         with:
-            branch: gh-pages
-            clean: true
-            folder: site
+          name: docs
+          path: site
+          if-no-files-found: error
+
+      - name: Deploy to GitHub Pages
+        if: contains(fromJSON('["push", "workflow_dispatch", "schedule"]'), github.event_name)
+        run: mkdocs gh-deploy --force
diff --git a/.github/workflows/lint-and-test.yml b/.github/workflows/lint-and-test.yml
@@ -0,0 +1,35 @@
+name: lint-and-test
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: pre-commit/[email protected]
+
+  test-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: "pip"
+
+      - name: Install Python requirements
+        run: pip install -r requirements.txt
+
+      - name: Build documentation
+        run: mkdocs build
+        env:
+          DEFAULT_LANGUAGE_ONLY: true
diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml
diff --git a/.github/workflows/zoho.yml b/.github/workflows/zoho.yml
@@ -0,0 +1,38 @@
+name: Update Zoho
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+
+      - name: Install Python requirements
+        run: pip install -r requirements.txt
+
+      - name: Install dependencies
+        env:
+          MKDOCS_INSIDERS_TOKEN: ${{ secrets.MKDOCS_INSIDERS_TOKEN }}
+        run: |
+          pip install -r requirements.txt
+          # pip install -r requirements-insiders.txt
+
+      - name: Generate Zoho authentication credentials and update Zoho
+        env:
+          IS_PR: ${{ github.event_name == 'pull_request' }}
+          ZOHO_CONFIG_ID: ${{ secrets.ZOHO_CONFIG_ID }}
+          ZOHO_CONFIG_SECRET: ${{ secrets.ZOHO_CONFIG_SECRET }}
+          ZOHO_CONFIG_CODE: ${{ secrets.ZOHO_CONFIG_CODE }}
+          ZOHO_REFRESH_TOKEN: ${{ secrets.ZOHO_REFRESH_TOKEN }}
+
+        run: |
+          python ./utils/push_to_zoho.py
diff --git a/.gitignore b/.gitignore
@@ -13,8 +13,11 @@ opengisch_rsa.pub
 *.DS_Store
 .idea
 .env
+.venv/
 Pipfile
 # The pipfile will have the exact python version and breaks builds on other systems
 Pipfile.lock
 .transifexrc
 /.python-version
+.cache
+.vscode
diff --git a/.markdown-link-check-config.json b/.markdown-link-check-config.json
@@ -0,0 +1,16 @@
+{
+  "replacementPatterns": [
+    {
+      "pattern": "#.*$",
+      "replacement": ""
+    },
+    {
+      "pattern": ".md$",
+      "replacement": ".en.md"
+    },
+    {
+      "pattern": ",[0-9]+px$",
+      "replacement": ""
+    }
+  ]
+}
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,3 +8,8 @@ repos:
       - id: mixed-line-ending
         args:
           - "--fix=lf"
+  - repo: https://github.com/tcort/markdown-link-check
+    rev: v3.11.2
+    hooks:
+      - id: markdown-link-check
+        args: [-q, -c, .markdown-link-check-config.json]
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ feel free to use it accordingly and to contribute back your updates via a
 [pull request](https://github.com/opengisch/QField-docs/pulls).
 
 
-[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/
+[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/ <!-- markdown-link-check-disable-line -->
 [cc-by-sa-shield]: https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg
 
 [![CC BY-SA 4.0][cc-by-sa-shield]][cc-by-sa]
@@ -114,7 +114,7 @@ pipenv install -r requirements.txt
 pipenv run mkdocs serve
 ```
 
-The local doc will be available at http://localhost:8000.
+The local doc will be available at http://localhost:8000.  <!-- markdown-link-check-disable-line -->
 
 #### Contribute
 Before commiting, install [pre-commit](https://pre-commit.com/) to auto-format your contributions. You can install pre-commit for the current user with
@@ -130,7 +130,7 @@ Ensure [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.
 1. Clone this repository: git clone https://github.com/opengisch/QField-docs
 2. Build the container: `docker build . -t qfield-docs`
 3. Run it: `docker run -it -v ${PWD}/documentation:/opt/app/documentation -p 8000:8000 qfield-docs`
-4. Point your browser to the serving endpoint at http://localhost:8000.
+4. Point your browser to the serving endpoint at http://localhost:8000.  <!-- markdown-link-check-disable-line -->
 
 The server will automatically live-reload with any change made to the local `./documentation` directory.
 

diff --git a/documentation/assets/images/accesing-sort-feature-list-op1.png b/documentation/assets/images/accesing-sort-feature-list-op1.png
diff --git a/documentation/assets/images/accesing-sort-feature-list-op2.png b/documentation/assets/images/accesing-sort-feature-list-op2.png
diff --git a/documentation/assets/images/activate-digitize-with-volumen-keys.png b/documentation/assets/images/activate-digitize-with-volumen-keys.png
diff --git a/documentation/assets/images/activate_finger_tap_digitizing.png b/documentation/assets/images/activate_finger_tap_digitizing.png
diff --git a/documentation/assets/images/application-plugins.png b/documentation/assets/images/application-plugins.png
diff --git a/documentation/assets/images/attachement-setting-audio.png b/documentation/assets/images/attachement-setting-audio.png
diff --git a/documentation/assets/images/attachement-setting-picture.png b/documentation/assets/images/attachement-setting-picture.png
diff --git a/documentation/assets/images/attachement-setting-video.png b/documentation/assets/images/attachement-setting-video.png
diff --git a/documentation/assets/images/attachments-qfield-media.png b/documentation/assets/images/attachments-qfield-media.png
diff --git a/documentation/assets/images/attachments.png b/documentation/assets/images/attachments.png
diff --git a/documentation/assets/images/attachments_directories.png b/documentation/assets/images/attachments_directories.png
diff --git a/documentation/assets/images/auto-push-pending-changes-qfield.png b/documentation/assets/images/auto-push-pending-changes-qfield.png
diff --git a/documentation/assets/images/auto-push-pending-changes-qfieldsync.png b/documentation/assets/images/auto-push-pending-changes-qfieldsync.png
diff --git a/documentation/assets/images/automatic-tracking-session.png b/documentation/assets/images/automatic-tracking-session.png
diff --git a/documentation/assets/images/changing_default_qfieldcloud_server_qfield.png b/documentation/assets/images/changing_default_qfieldcloud_server_qfield.png
diff --git a/documentation/assets/images/changing_default_qfieldcloud_server_qfield_sync.png b/documentation/assets/images/changing_default_qfieldcloud_server_qfield_sync.png
diff --git a/documentation/assets/images/checkbox-show-package.png b/documentation/assets/images/checkbox-show-package.png
diff --git a/documentation/assets/images/checked-show-package.png b/documentation/assets/images/checked-show-package.png
diff --git a/documentation/assets/images/code-reader-nfc-text-tag.png b/documentation/assets/images/code-reader-nfc-text-tag.png
diff --git a/documentation/assets/images/converting-project-to-organization-01.png b/documentation/assets/images/converting-project-to-organization-01.png
diff --git a/documentation/assets/images/converting-project-to-organization-02.png b/documentation/assets/images/converting-project-to-organization-02.png
diff --git a/documentation/assets/images/custom-units-measure.png b/documentation/assets/images/custom-units-measure.png
diff --git a/documentation/assets/images/digitizing-with-qr-code-1-attribute-form.png b/documentation/assets/images/digitizing-with-qr-code-1-attribute-form.png
diff --git a/documentation/assets/images/digitizing-with-qr-code-2-selecting-scan-code.png b/documentation/assets/images/digitizing-with-qr-code-2-selecting-scan-code.png
diff --git a/documentation/assets/images/digitizing-with-qr-code-3-code-reader.png b/documentation/assets/images/digitizing-with-qr-code-3-code-reader.png
diff --git a/documentation/assets/images/digitizing-with-qr-code-4-it-worked.png b/documentation/assets/images/digitizing-with-qr-code-4-it-worked.png
diff --git a/documentation/assets/images/discontinuing_service_01_enter_to_setting.png b/documentation/assets/images/discontinuing_service_01_enter_to_setting.png
diff --git a/documentation/assets/images/discontinuing_service_02_change_subcription.png b/documentation/assets/images/discontinuing_service_02_change_subcription.png
diff --git a/documentation/assets/images/discontinuing_service_03_cancel_subscription.png b/documentation/assets/images/discontinuing_service_03_cancel_subscription.png
diff --git a/documentation/assets/images/discontinuing_service_04_popup_cancel_subcription.png b/documentation/assets/images/discontinuing_service_04_popup_cancel_subcription.png
diff --git a/documentation/assets/images/discontinuing_service_05_nyuki_message.png b/documentation/assets/images/discontinuing_service_05_nyuki_message.png
diff --git a/documentation/assets/images/export-qfieldcloud-files-from-qfield-1-gear-icon.png b/documentation/assets/images/export-qfieldcloud-files-from-qfield-1-gear-icon.png
diff --git a/...on/assets/images/export-qfieldcloud-files-from-qfield-2-open-folder-project.png b/...on/assets/images/export-qfieldcloud-files-from-qfield-2-open-folder-project.png
diff --git a/documentation/assets/images/export-qfieldcloud-files-from-qfield-3-three-dots.png b/documentation/assets/images/export-qfieldcloud-files-from-qfield-3-three-dots.png
diff --git a/...tation/assets/images/export-qfieldcloud-files-from-qfield-4-options-to-send.png b/...tation/assets/images/export-qfieldcloud-files-from-qfield-4-options-to-send.png
diff --git a/documentation/assets/images/external_receiver_log.png b/documentation/assets/images/external_receiver_log.png
diff --git a/documentation/assets/images/files_versions_for_deleting.png b/documentation/assets/images/files_versions_for_deleting.png
diff --git a/documentation/assets/images/files_versions_for_deleting_2.png b/documentation/assets/images/files_versions_for_deleting_2.png
diff --git a/documentation/assets/images/files_versions_for_deleting_also_delete.png b/documentation/assets/images/files_versions_for_deleting_also_delete.png
diff --git a/documentation/assets/images/files_versions_for_deleting_deleting_a_version.png b/documentation/assets/images/files_versions_for_deleting_deleting_a_version.png
diff --git a/documentation/assets/images/files_versions_for_deleting_files_versions.png b/documentation/assets/images/files_versions_for_deleting_files_versions.png
diff --git a/documentation/assets/images/files_versions_for_deleting_three_dots.png b/documentation/assets/images/files_versions_for_deleting_three_dots.png
diff --git a/documentation/assets/images/files_versions_for_deleting_version_remain.png b/documentation/assets/images/files_versions_for_deleting_version_remain.png
diff --git a/documentation/assets/images/frequency_notifications_settings.png b/documentation/assets/images/frequency_notifications_settings.png
diff --git a/documentation/assets/images/hide-form-on-add-feature.png b/documentation/assets/images/hide-form-on-add-feature.png
diff --git a/documentation/assets/images/hiding-legend-nodes.png b/documentation/assets/images/hiding-legend-nodes.png
diff --git a/documentation/assets/images/main_menu_sensors.png b/documentation/assets/images/main_menu_sensors.png
diff --git a/documentation/assets/images/maximum-distance-tolerance.png b/documentation/assets/images/maximum-distance-tolerance.png
diff --git a/documentation/assets/images/maximum-items-visible-in-relation.png b/documentation/assets/images/maximum-items-visible-in-relation.png
diff --git a/documentation/assets/images/opacity-slider.png b/documentation/assets/images/opacity-slider.png
diff --git a/documentation/assets/images/paths-saving-media.png b/documentation/assets/images/paths-saving-media.png
diff --git a/documentation/assets/images/picture_path.png b/documentation/assets/images/picture_path.png
diff --git a/documentation/assets/images/print_atlas_menu.png b/documentation/assets/images/print_atlas_menu.png
diff --git a/documentation/assets/images/print_document.jpg b/documentation/assets/images/print_document.jpg
diff --git a/documentation/assets/images/print_document.png b/documentation/assets/images/print_document.png
diff --git a/documentation/assets/images/print_menu.png b/documentation/assets/images/print_menu.png
diff --git a/documentation/assets/images/project_organization_01_entering_into_organization.png b/documentation/assets/images/project_organization_01_entering_into_organization.png
diff --git a/documentation/assets/images/project_organization_02_creating_project.png b/documentation/assets/images/project_organization_02_creating_project.png
diff --git a/documentation/assets/images/project_organization_03_new_empty_project.png b/documentation/assets/images/project_organization_03_new_empty_project.png
diff --git a/documentation/assets/images/project_organization_04_new_project_created.png b/documentation/assets/images/project_organization_04_new_project_created.png
diff --git a/documentation/assets/images/project_organization_05_qfield_sync.png b/documentation/assets/images/project_organization_05_qfield_sync.png
diff --git a/documentation/assets/images/project_organization_06_selecting_folder.png b/documentation/assets/images/project_organization_06_selecting_folder.png
diff --git a/documentation/assets/images/project_organization_07_copy_project_to_folder.png b/documentation/assets/images/project_organization_07_copy_project_to_folder.png
diff --git a/documentation/assets/images/project_organization_08_qfield_sync_overview.png b/documentation/assets/images/project_organization_08_qfield_sync_overview.png
diff --git a/documentation/assets/images/project_organization_09_pushing_changes_to_cloud.png b/documentation/assets/images/project_organization_09_pushing_changes_to_cloud.png
diff --git a/documentation/assets/images/project_organization_10_files_overview_in_cloud.png b/documentation/assets/images/project_organization_10_files_overview_in_cloud.png
diff --git a/...mentation/assets/images/project_organization_11_transfering_to_organization.png b/...mentation/assets/images/project_organization_11_transfering_to_organization.png
diff --git a/documentation/assets/images/project_organization_12_confirming_transfer.png b/documentation/assets/images/project_organization_12_confirming_transfer.png
diff --git a/documentation/assets/images/qfc-get-started-brown.png b/documentation/assets/images/qfc-get-started-brown.png
diff --git a/documentation/assets/images/qfc-get-started-dashboard.png b/documentation/assets/images/qfc-get-started-dashboard.png
diff --git a/documentation/assets/images/qfc-get-started-green.png b/documentation/assets/images/qfc-get-started-green.png
diff --git a/documentation/assets/images/qfc-get-started-red.png b/documentation/assets/images/qfc-get-started-red.png
diff --git a/documentation/assets/images/qfc_offline_packager.png b/documentation/assets/images/qfc_offline_packager.png
diff --git a/documentation/assets/images/qfield-syinc-subdirs-exporting-project.png b/documentation/assets/images/qfield-syinc-subdirs-exporting-project.png
diff --git a/documentation/assets/images/qfield-sync-properties.png b/documentation/assets/images/qfield-sync-properties.png
diff --git a/documentation/assets/images/qfield-sync_package1.png b/documentation/assets/images/qfield-sync_package1.png
diff --git a/documentation/assets/images/qfield-tracking-session.png b/documentation/assets/images/qfield-tracking-session.png
diff --git a/documentation/assets/images/qfieldsync-preferences-button.png b/documentation/assets/images/qfieldsync-preferences-button.png
diff --git a/documentation/assets/images/re-apply-changes-in-qfieldcloud.png b/documentation/assets/images/re-apply-changes-in-qfieldcloud.png
diff --git a/documentation/assets/images/resolving_conflicts.gif b/documentation/assets/images/resolving_conflicts.gif
diff --git a/documentation/assets/images/search-bar-code-reader-1-scanning.png b/documentation/assets/images/search-bar-code-reader-1-scanning.png
diff --git a/documentation/assets/images/search-bar-code-reader-2-results.png b/documentation/assets/images/search-bar-code-reader-2-results.png
diff --git a/documentation/assets/images/search-bar.png b/documentation/assets/images/search-bar.png
diff --git a/documentation/assets/images/sensors.webp b/documentation/assets/images/sensors.webp
diff --git a/documentation/assets/images/sensors_information_panel.png b/documentation/assets/images/sensors_information_panel.png
diff --git a/documentation/assets/images/sensors_menu.png b/documentation/assets/images/sensors_menu.png
diff --git a/documentation/assets/images/sensors_tracker_constraint.png b/documentation/assets/images/sensors_tracker_constraint.png
diff --git a/documentation/assets/images/service_config_file_001.png b/documentation/assets/images/service_config_file_001.png
diff --git a/documentation/assets/images/service_config_file_002.png b/documentation/assets/images/service_config_file_002.png
diff --git a/documentation/assets/images/service_config_file_003.png b/documentation/assets/images/service_config_file_003.png
diff --git a/documentation/assets/images/service_config_file_004.png b/documentation/assets/images/service_config_file_004.png
diff --git a/documentation/assets/images/setting-maximum-items-visible-in-relation.png b/documentation/assets/images/setting-maximum-items-visible-in-relation.png
diff --git a/documentation/assets/images/storage-export-actions.png b/documentation/assets/images/storage-export-actions.png
diff --git a/documentation/assets/images/storage-import-actions.png b/documentation/assets/images/storage-import-actions.png
diff --git a/documentation/assets/images/storage-import-url.png b/documentation/assets/images/storage-import-url.png
diff --git a/documentation/assets/images/storage-qfc1.png b/documentation/assets/images/storage-qfc1.png
diff --git a/documentation/assets/images/storage-qfc2.png b/documentation/assets/images/storage-qfc2.png
diff --git a/documentation/assets/images/storage-qfc3.png b/documentation/assets/images/storage-qfc3.png
diff --git a/documentation/assets/images/unchecked-show-package.png b/documentation/assets/images/unchecked-show-package.png
diff --git a/documentation/assets/projects/advanced-bee-farming.zip b/documentation/assets/projects/advanced-bee-farming.zip
diff --git a/documentation/assets/projects/bee_farming_project.zip b/documentation/assets/projects/bee_farming_project.zip
diff --git a/documentation/assets/projects/qfield-users-survey.zip b/documentation/assets/projects/qfield-users-survey.zip
diff --git a/documentation/assets/projects/simple-bee-farming.zip b/documentation/assets/projects/simple-bee-farming.zip
diff --git a/documentation/assets/projects/wasterwater_management_project.zip b/documentation/assets/projects/wasterwater_management_project.zip
diff --git a/documentation/assets/videos/drawing-sketch-feature2.webm b/documentation/assets/videos/drawing-sketch-feature2.webm
diff --git a/documentation/assets/videos/snap-to-common-angles.webm b/documentation/assets/videos/snap-to-common-angles.webm
diff --git a/documentation/get-started/concepts.en.md b/documentation/get-started/concepts.en.md
@@ -1,46 +1,37 @@
 ---
-title: Concepts
+title: Principles
 tx_slug: documentation_get-started_concepts
 ---
 
-# Concepts
+# Principles
 
-QField was designed with a few key concepts in mind.
+QField is designed with a few key principles in mind.
 
-## Keep it simple
 
-The requirements on the field are not the same as on a desktop. The
-screen is smaller, the input devices are different and the tasks are
-different.
+## Keeping it simple
 
-QField aims to help users to perform the tasks they need to do without
-cluttering the user interface. This means, that only tasks which need to
-be done on the field are availble from the interface. Everything else is
-not.
+The requirements in the field are not the same as on a desktop.
+Firstly, when using a phone or a tablet, the canvas to work on is much more limited than a computer monitor.
+Secondly, devices for data collection as well as the individual tasks that need to be performed are vastly different.
 
-This means that everything like layer styling, form definitions and
-other project setup steps should be done on a computer with QGIS
-installed first.
+QField aims to help users do fieldwork without the nuisance of a cluttered user interface.
+In other words, only the relevant parts of a task are accessible on the interface, while less important things remain out of sight.
 
-## Be compatible with QGIS
+Before heading out to the field though, preliminary steps such as layer styling, tailored forms, or any other project configurations should first be done on the QGIS desktop version.
 
-QField is based on QGIS. It is not a rebuild of QGIS it really *does*
-use QGIS libraries. The rendering engine is exactly the same as in QGIS
-for desktop and your project will therefore look exactly the same on
-your mobile device as it does on your computer.
+## Compatibility with QGIS
 
-If something is already available as a configuration option in a QGIS
-project, it should not be re-invented. QField therefore uses the same
-edit widgets as QGIS desktop does. If a project is already configured
-for the desktop, it should just run on mobile as well.
+Since QField relies on existing QGIS Libraries, it is not an extensive rebuild of QGIS.
+The rendering engine in QField is the same as the one used in desktop QGIS, ensuring that projects will appear virtually identical in both environments.
 
-Remember, this is just the *concept*. This is what we have in mind when
-we develop QField. It does not mean that it is already completely there
-yet.
+Configurations options prepared in QGIS beforehand don't need to be recreated, which is why QField uses the same edit widgets as QGIS desktop does.
+As a result, projects configured on the desktop should work seamlessly on the mobile app.
+
+These principles have so far informed our development and design of QField, and will continue to do so in the future.
+Even though QField has been around for some time now, it is still a work in progress.
 
 ## Mode based
 
-QField is built around *modes*. Modes are similar to a *map tool* in
-QGIS desktop. A mode defines the task which a user is currently doing.
-Either a user is *browsing* through the data or she is *digitizing*
-something new.
+QField is built around different *modes*, similar to the *map tools* in the QGIS desktop version.
+The mode defines the nature of the task.
+In QField, users are either *browsing* through data or *digitizing* new stuff.
diff --git a/documentation/get-started/contribute.en.md b/documentation/get-started/contribute.en.md
@@ -7,27 +7,27 @@ tx_slug: documentation_get-started_contribute
 
 QField is an open source project. It is free to share, use and modify and it will stay like that. We are very happy if this app helps you in whatever creative way you may use it. If you found it useful, we will be even happier if you could give something back. A couple of things you can do are:
 
-  - Rate the app [★★★★★](https://play.google.com/store/apps/details?id=ch.opengis.qfield&hl=en#details-reviews);
-  - [Tweet about it](https://twitter.com/share?text=Looking%20for%20a%20good%20tool%20for%20field%20work%20in%20GIS?%20Check%20out%20%23QField!);
-  - [Follow us on twitter](https://twitter.com/QFieldForQGIS);
-  - Write about your experience ([please let us know!](mailto:[email protected]));
-  - [Help with the documentation](https://github.com/opengisch/QField-docs#documentation-process);
-  - [Translate the documentation](https://github.com/opengisch/QField-docs#translation-process) or [the app](https://www.transifex.com/opengisch/qfield-for-qgis/);
-  - [Sponsor a feature](https://docs.qfield.org/get-started/sponsor/); or
+  - Rate the app [★★★★★](https://play.google.com/store/apps/details?id=ch.opengis.qfield&hl=en#details-reviews); <!-- markdown-link-check-disable-line -->
+  - [Tweet about it](https://twitter.com/share?text=Looking%20for%20a%20good%20tool%20for%20field%20work%20in%20GIS?%20Check%20out%20%23QField!); <!-- markdown-link-check-disable-line -->
+  - [Follow us on twitter](https://twitter.com/QFieldForQGIS); <!-- markdown-link-check-disable-line -->
+  - Write about your experience ([please let us know!](mailto:[email protected])); <!-- markdown-link-check-disable-line -->
+  - [Help with the documentation](https://github.com/opengisch/QField-docs#documentation-process); <!-- markdown-link-check-disable-line -->
+  - [Translate the documentation](https://github.com/opengisch/QField-docs#translation-process) or [the app](https://www.transifex.com/opengisch/qfield-for-qgis/); <!-- markdown-link-check-disable-line -->
+  - [Sponsor a feature](https://docs.qfield.org/get-started/sponsor/); <!-- markdown-link-check-disable-line --> or
   - Just drop by to say thank you or have a beer with us next time you meet OPENGIS.ch at a conference.
 
 # Development
 
 if you want to get involved in QField development, please refer to the following doumentations:
-  - [QField repository](https://github.com/opengisch/QField/blob/master/doc/dev.md)
-  - [QFieldCloud repository](https://github.com/opengisch/qfieldcloud)
-  - [QFieldSync repository](https://github.com/opengisch/QFieldSync)
+  - [QField repository](https://github.com/opengisch/QField/blob/master/doc/dev.md) <!-- markdown-link-check-disable-line -->
+  - [QFieldCloud repository](https://github.com/opengisch/qfieldcloud) <!-- markdown-link-check-disable-line -->
+  - [QFieldSync repository](https://github.com/opengisch/QFieldSync) <!-- markdown-link-check-disable-line -->
 
 # Credits
 
-QField, QFieldCloud and QFieldSync are developped by [OPENGIS.ch](https://www.opengis.ch/). OPENGIS.ch does [consulting](https://www.opengis.ch/training-consulting/),
-[development](https://www.opengis.ch/custom-development/), [training](https://www.opengis.ch/qfield-training/) and [support](https://www.opengis.ch/qgis-support/) for open source software including QField and
+QField, QFieldCloud and QFieldSync are developped by [OPENGIS.ch](https://www.opengis.ch/) <!-- markdown-link-check-disable-line -->. OPENGIS.ch does [consulting](https://www.opengis.ch/training-consulting/) <!-- markdown-link-check-disable-line -->,
+[development](https://www.opengis.ch/custom-development/) <!-- markdown-link-check-disable-line -->, [training](https://www.opengis.ch/qfield-training/) <!-- markdown-link-check-disable-line --> and [support](https://www.opengis.ch/qgis-support/) <!-- markdown-link-check-disable-line --> for open source software including QField and
 QGIS.
 
 
-[![OPENGIS.ch](../assets/images/opengisch_main_transparent.png){width="200px"}](http://www.opengis.ch)
+[![OPENGIS.ch](../assets/images/opengisch_main_transparent.png){width="200px"}](http://www.opengis.ch) <!-- markdown-link-check-disable-line -->
diff --git a/documentation/get-started/faq.en.md b/documentation/get-started/faq.en.md
@@ -30,4 +30,4 @@ tx_slug: documentation_get-started_faq
     ## I have a question about QField or QFieldCloud. Who can I ask?
     We have a [discussion platform](https://github.com/opengisch/QField/discussions) to connect with other members of our community. If you need professional support please [contact us](mailto:[email protected]).
 
-You can find more plans and service related questions in the [QFieldCloud FAQ](https://qfield.cloud/faq/) page.
+You can find more plans and service related questions in the [QFieldCloud FAQ](https://qfield.cloud/faq) page.