IMPROVEMENT: lint the markdown files

amilcarlucas · amilcarlucas · commit 01c3505cb688 · 2024-12-18T21:55:24.000+01:00
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,27 @@
+---
+default: true
+line-length: false
+fix: true
+no-trailing-punctuation: false
+no-inline-html:
+  enabled: false
+MD013:
+  line_length: 500
+  code_blocks: false
+  tables: false
+  headers: false
+MD033:
+  allowed_elements:
+    - "span"
+    - "i"
+    - "a"
+    - "b"
+    - "br"
+    - "caption"
+    - "figure"
+    - "img"
+    - "ins"
+    - "table"
+    - "td"
+    - "th"
+    - "tr"
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -41,6 +41,22 @@ repos:
           ]
         stages: [pre-push]
 
+  - repo: https://github.com/gruntwork-io/pre-commit
+    rev: v0.1.24
+    hooks:
+      - id: shellcheck
+        entry: C:\\Windows\\System32\\wsl.exe --exec bash -c "find . -type f \( -name '*.sh' -o -name '*.bash' \) ! -name 'get-helm-3.bash' -print0 | xargs -0 printf '%q ' | xargs shellcheck --color=never"
+        files: \.bash$
+      - id: markdown-link-check
+        language: system
+        entry: markdown-link-check
+
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.43.0
+    hooks:
+      - id: markdownlint
+        args: ['--config', '.markdownlint.yaml', '--ignore', 'MD025']
+
   # - repo: https://github.com/RobertCraigie/pyright-python
   #   rev: v1.1.389
   #   hooks:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,11 +1,11 @@
-# Contributing
+# How to contribute to the ArduPilot Methodic Configurator project?
 <!--
 SPDX-FileCopyrightText: 2024 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
 
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
-## How to contribute to the ArduPilot Methodic Configurator project?
+<!-- markdownlint-disable MD025 -->
 
 If you are reading this page, you are possibly interested in contributing to our project.
 We have a very active (and friendly) developer group and would love to have the help!
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,5 +1,8 @@
-                    GNU GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
+# GNU GENERAL PUBLIC LICENSE
+
+## Version 3, 29 June 2007
+
+<!-- markdownlint-disable MD029 -->
 
  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  Everyone is permitted to copy and distribute verbatim copies
@@ -653,11 +656,11 @@ Also add information on how to contact you by electronic and paper mail.
 notice like this when it starts in an interactive mode:
 
     <program>  Copyright (C) <year>  <name of author>
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w`.
     This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
+    under certain conditions; type `show c` for details.
 
-The hypothetical commands `show w' and `show c' should show the appropriate
+The hypothetical commands `show w` and `show c` should show the appropriate
 parts of the General Public License.  Of course, your program's commands
 might be different; for a GUI interface, you would use an "about box".
 
diff --git a/QUICKSTART.md b/QUICKSTART.md
@@ -15,7 +15,9 @@ To methodically build, configure and tune ArduPilot vehicles follow this sequenc
 
 ### 1.1 Select the vehicle components
 
-- while [choosing an Autopilot](https://ardupilot.org/copter/docs/common-autopilots.html) and [other hardware](https://ardupilot.org/copter/docs/common-optional-hardware.html) components [avoid these components](https://discuss.ardupilot.org/t/hardware-to-avoid-when-building-your-first-multirotor/114014/1)
+- while [choosing an Autopilot](https://ardupilot.org/copter/docs/common-autopilots.html) and
+  [other hardware](https://ardupilot.org/copter/docs/common-optional-hardware.html) components
+  [avoid these components](https://discuss.ardupilot.org/t/hardware-to-avoid-when-building-your-first-multirotor/114014/1)
 - Use [ecalc for multirotor](https://www.ecalc.ch/index.htm) to select the propulsion system.
 - follow [hardware best practices](TUNING_GUIDE_ArduCopter.md#11-multicopter-hardware-best-practices)
 
diff --git a/README.md b/README.md
@@ -13,7 +13,8 @@ SPDX-License-Identifier: GPL-3.0-or-later
 | [![mypy](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/mypy.yml/badge.svg)](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/mypy.yml) | [![Known Vulnerabilities](https://snyk.io/test/github/amilcarlucas/MethodicConfigurator/badge.svg)](https://snyk.io/test/github/amilcarlucas/MethodicConfigurator) | [![codecov](https://codecov.io/github/amilcarlucas/MethodicConfigurator/graph/badge.svg?token=76P928EOL2)](https://codecov.io/github/amilcarlucas/MethodicConfigurator) | [![Windows Build](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/windows_build.yml/badge.svg)](https://github.com/ArduPilot/MethodicConfigurator/actions/workflows/windows_build.yml) | |
 | | [![Code Climate](https://codeclimate.com/github/amilcarlucas/MethodicConfigurator.png)](https://codeclimate.com/github/amilcarlucas/MethodicConfigurator) | [![Coverity Scan Build Status](https://scan.coverity.com/projects/30346/badge.svg)](https://scan.coverity.com/projects/ardupilot-methodic-configurator) | | |
 
-Amilcar Lucas's ArduPilot Methodic Configurator is a software that semi-automates a [clear, proven and safe configuration sequence for ArduCopter drones](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduCopter).
+Amilcar Lucas's ArduPilot Methodic Configurator is a software that semi-automates a
+[clear, proven and safe configuration sequence for ArduCopter drones](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduCopter).
 
 - **clear**: the sequence is linear, executed one step at the time with no hidden complex dependencies
 - **proven**: the software has been used by hundreds of ArduPilot developers and users. From beginners to advanced. On big and small vehicles.
@@ -25,7 +26,9 @@ It provides a graphical user interface (GUI) for managing and visualizing ArduPi
 
 ![Application Screenshot](https://github.com/ArduPilot/MethodicConfigurator/blob/master/images/App_screenshot1.png?raw=true)
 
-We are working on extending it to [ArduPlane](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduPlane), [Heli](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_Heli) and [Rover](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_Rover) vehicles.
+We are working on extending it to [ArduPlane](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduPlane),
+[Heli](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_Heli) and
+[Rover](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_Rover) vehicles.
 But for those it is still very incomplete.
 
 ## Usage
@@ -80,11 +83,14 @@ cd MethodicConfigurator
 
 ## Support and Contributing
 
-Please feel free to submit [issues](https://github.com/ArduPilot/MethodicConfigurator/issues) or [pull requests](https://github.com/ArduPilot/MethodicConfigurator/pulls). More information is available on the [contributing and support](https://github.com/ArduPilot/MethodicConfigurator/blob/master/CONTRIBUTING.md) page.
+Please feel free to submit [issues](https://github.com/ArduPilot/MethodicConfigurator/issues) or
+[pull requests](https://github.com/ArduPilot/MethodicConfigurator/pulls).
+More information is available on the [contributing and support](https://github.com/ArduPilot/MethodicConfigurator/blob/master/CONTRIBUTING.md) page.
 
 ## Software architecture
 
-To meet the [Software requirements](https://ardupilot.github.io/MethodicConfigurator/ARCHITECTURE.html#software-requirements) a [software architecture](https://ardupilot.github.io/MethodicConfigurator/ARCHITECTURE.html#the-software-architecture) was designed and implemented.
+To meet the [Software requirements](https://ardupilot.github.io/MethodicConfigurator/ARCHITECTURE.html#software-requirements) a
+[software architecture](https://ardupilot.github.io/MethodicConfigurator/ARCHITECTURE.html#the-software-architecture) was designed and implemented.
 
 ## Code of conduct
 
diff --git a/TUNING_GUIDE_ArduCopter.md b/TUNING_GUIDE_ArduCopter.md
@@ -5,6 +5,8 @@ SPDX-FileCopyrightText: 2024 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
+<!-- markdownlint-disable MD013 MD025 MD034 -->
+
 ![Cinewhoop Diatone Taycan MX-C](images/blog/cinewhoop.png)
 
 For illustrative purposes, we will use the small 3'' multicopter depicted above, but the tuning sequence we developed at [IAV GmbH](https://www.iav.com/) will work on almost any other multicopter.
@@ -203,7 +205,6 @@ The figure excludes the LiPo battery and the PM02 BEC with a voltage/current mon
 
 ![Matek H743, Holobro F9p, T-Motor F45 4in1 ESC and TBS Crossfire Nano rx se connections](images/blog/matek_h743_schaltplan.png)
 
-
 # 6. Basic mandatory configuration
 
 ## 6.1 Configure flight controller orientation
@@ -1047,10 +1048,10 @@ In this case, it is:
 
 > max_accel = 4.2 [m/s²]
 
-With the air density at the time of testing and the previously calculated ballistic drag coefficient (`EK3_DRAG_BCOEF_X` for front and back, `EK3_DRAG_BCOEF_Y` for left and right side) you can now calculate the bluff body drag, which is 1/2 * air density * airspeed^2 / BCOEF.
+With the air density at the time of testing and the previously calculated ballistic drag coefficient (`EK3_DRAG_BCOEF_X` for front and back, `EK3_DRAG_BCOEF_Y` for left and right side) you can now calculate the bluff body drag, which is 1/2 \* air density \* airspeed^2 / BCOEF.
 In this case, it is:
 
-> Bluff body drag = 0.5 * 1.260 [kg/m³] * (6.25 [m/s])² / 38.4798 [kg/m²] = 0.6395 [m/s²]
+> Bluff body drag = 0.5 \* 1.260 [kg/m³] \* (6.25 [m/s])² / 38.4798 [kg/m²] = 0.6395 [m/s²]
 
 With that, you can now calculate the momentum drag, which is max_accel - bluff body drag.
 In this case, it is:
diff --git a/TUNING_GUIDE_ArduPlane.md b/TUNING_GUIDE_ArduPlane.md
@@ -5,6 +5,8 @@ SPDX-FileCopyrightText: 2024 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
+<!-- markdownlint-disable MD013 MD025 MD034 -->
+
 ![Cinewhoop Diatone Taycan MX-C](images/blog/cinewhoop.png)
 
 For illustrative purposes, we will use the small 3'' multicopter depicted above, but the tuning sequence we developed at [IAV GmbH](https://www.iav.com/) will work on almost any other multicopter.
@@ -203,7 +205,6 @@ The figure excludes the LiPo battery and the PM02 BEC with a voltage/current mon
 
 ![Matek H743, Holobro F9p, T-Motor F45 4in1 ESC and TBS Crossfire Nano rx se connections](images/blog/matek_h743_schaltplan.png)
 
-
 # 6. Basic mandatory configuration
 
 ## 6.1 Configure flight controller orientation
@@ -1043,10 +1044,10 @@ In this case, it is:
 
 > max_accel = 4.2 [m/s²]
 
-With the air density at the time of testing and the previously calculated ballistic drag coefficient (`EK3_DRAG_BCOEF_X` for front and back, `EK3_DRAG_BCOEF_Y` for left and right side) you can now calculate the bluff body drag, which is 1/2 * air density * airspeed^2 / BCOEF.
+With the air density at the time of testing and the previously calculated ballistic drag coefficient (`EK3_DRAG_BCOEF_X` for front and back, `EK3_DRAG_BCOEF_Y` for left and right side) you can now calculate the bluff body drag, which is 1/2 \* air density \* airspeed^2 / BCOEF.
 In this case, it is:
 
-> Bluff body drag = 0.5 * 1.260 [kg/m³] * (6.25 [m/s])² / 38.4798 [kg/m²] = 0.6395 [m/s²]
+> Bluff body drag = 0.5 \* 1.260 [kg/m³] \* (6.25 [m/s])² / 38.4798 [kg/m²] = 0.6395 [m/s²]
 
 With that, you can now calculate the momentum drag, which is max_accel - bluff body drag.
 In this case, it is:
diff --git a/TUNING_GUIDE_Heli.md b/TUNING_GUIDE_Heli.md
@@ -5,6 +5,8 @@ SPDX-FileCopyrightText: 2024 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
+<!-- markdownlint-disable MD013 MD025 MD034 -->
+
 ![Cinewhoop Diatone Taycan MX-C](images/blog/cinewhoop.png)
 
 For illustrative purposes, we will use the small 3'' multicopter depicted above, but the tuning sequence we developed at [IAV GmbH](https://www.iav.com/) will work on almost any other multicopter.
@@ -23,7 +25,7 @@ You will be able to tune multiple vehicles (think production line) using this me
 4. [Perform IMU temperature calibration before assembling the autopilot into the vehicle](#4-perform-imu-temperature-calibration-before-assembling-the-autopilot-into-the-vehicle-optional) (optional)
 5. [Assemble all components except the propellers](#5-assemble-all-components-except-the-propellers)
 6. [Basic mandatory configuration](#6-basic-mandatory-configuration)
-7. [Assemble propellers and perform the first flight](#7-assemble-propellers-and-perform-the-first-flight)
+7. [Install rotor blades and perform the first flight](#7-install-rotor-blades-and-perform-the-first-flight)
 8. [Minimalistic mandatory tuning](#8-minimalistic-mandatory-tuning)
 9. [Standard tuning](#9-standard-tuning-optional) (optional)
 10. [Improve altitude under windy conditions](#10-improve-altitude-under-windy-conditions-optional) (optional)
@@ -181,7 +183,7 @@ After the calibration, temperature changes will cause no significant acceleromet
 
 Now that the optional IMU temperature calibration is done we must assemble and connect all components except the propellers.
 
-Read the [Helicopter hardware best-practices](#11-Helicopter-hardware-best-practices) section again before assembling the vehicle.
+Read the [Helicopter hardware best-practices](#11-helicopter-hardware-best-practices) section again before assembling the vehicle.
 
 If you changed the way the components are connected to the flight controller (FC), re-enter the updated information into ArduPilot Methodic Configurator [component editor window](USERMANUAL.md#vehicle-component-editor-interface).
 
@@ -202,7 +204,6 @@ The figure excludes the LiPo battery and the PM02 BEC with a voltage/current mon
 
 ![Insert Heli example of connections](images/blog/matek_h743_schaltplan.png)
 
-
 # 6. Basic mandatory configuration
 
 ## 6.1 Configure flight controller orientation
@@ -511,8 +512,6 @@ The table below explains which bit is responsible for which `.bin` dataflash log
 <tr><td>WINC</td><td>Winch</td><td>10Hz</td><td>Any</td><td>any</td><td>any</td></tr>
 </table>
 
-
-
 ## 6.14 Optional PID adjustment (not sure how this applies to helicopters)
 
 If you have a very small, or a very large vehicle that requires non-default PID values for a safe flight.
@@ -988,10 +987,10 @@ In this case, it is:
 
 > max_accel = 4.2 [m/s²]
 
-With the air density at the time of testing and the previously calculated ballistic drag coefficient (`EK3_DRAG_BCOEF_X` for front and back, `EK3_DRAG_BCOEF_Y` for left and right side) you can now calculate the bluff body drag, which is 1/2 * air density * airspeed^2 / BCOEF.
+With the air density at the time of testing and the previously calculated ballistic drag coefficient (`EK3_DRAG_BCOEF_X` for front and back, `EK3_DRAG_BCOEF_Y` for left and right side) you can now calculate the bluff body drag, which is 1/2 \* air density \* airspeed^2 / BCOEF.
 In this case, it is:
 
-> Bluff body drag = 0.5 * 1.260 [kg/m³] * (6.25 [m/s])² / 38.4798 [kg/m²] = 0.6395 [m/s²]
+> Bluff body drag = 0.5 \* 1.260 [kg/m³] \* (6.25 [m/s])² / 38.4798 [kg/m²] = 0.6395 [m/s²]
 
 With that, you can now calculate the momentum drag, which is max_accel - bluff body drag.
 In this case, it is:
diff --git a/TUNING_GUIDE_Rover.md b/TUNING_GUIDE_Rover.md
@@ -5,6 +5,8 @@ SPDX-FileCopyrightText: 2024 Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
+<!-- markdownlint-disable MD013 MD025 MD034 -->
+
 ![Cinewhoop Diatone Taycan MX-C](images/blog/cinewhoop.png)
 
 For illustrative purposes, we will use the small 3'' multicopter depicted above, but the tuning sequence we developed at [IAV GmbH](https://www.iav.com/) will work on almost any other multicopter.
@@ -203,7 +205,6 @@ The figure excludes the LiPo battery and the PM02 BEC with a voltage/current mon
 
 ![Matek H743, Holobro F9p, T-Motor F45 4in1 ESC and TBS Crossfire Nano rx se connections](images/blog/matek_h743_schaltplan.png)
 
-
 # 6. Basic mandatory configuration
 
 ## 6.1 Configure flight controller orientation
@@ -1043,10 +1044,10 @@ In this case, it is:
 
 > max_accel = 4.2 [m/s²]
 
-With the air density at the time of testing and the previously calculated ballistic drag coefficient (`EK3_DRAG_BCOEF_X` for front and back, `EK3_DRAG_BCOEF_Y` for left and right side) you can now calculate the bluff body drag, which is 1/2 * air density * airspeed^2 / BCOEF.
+With the air density at the time of testing and the previously calculated ballistic drag coefficient (`EK3_DRAG_BCOEF_X` for front and back, `EK3_DRAG_BCOEF_Y` for left and right side) you can now calculate the bluff body drag, which is 1/2 \* air density \* airspeed^2 / BCOEF.
 In this case, it is:
 
-> Bluff body drag = 0.5 * 1.260 [kg/m³] * (6.25 [m/s])² / 38.4798 [kg/m²] = 0.6395 [m/s²]
+> Bluff body drag = 0.5 \* 1.260 [kg/m³] \* (6.25 [m/s])² / 38.4798 [kg/m²] = 0.6395 [m/s²]
 
 With that, you can now calculate the momentum drag, which is max_accel - bluff body drag.
 In this case, it is:
diff --git a/USERMANUAL.md b/USERMANUAL.md
@@ -142,7 +142,9 @@ ARMING_RUDDER,0 # We find it safer to use only a switch to arm instead of throug
 
 If you are working with multiple vehicles, create a separate directory for each vehicle with a descriptive identifiable name. Copy the aprox. 50 *intermediate parameter files* into them. Edit the files to match the specific requirements of each vehicle. Now you have traceable documentation records for every parameter change on each of your vehicles.
 
-If you are in the business of manufacturing multicopters and maintain **high-quality standards that result in the production of multiple, nearly identical vehicles**, you can reuse most intermediate parameter files across these vehicles. Only three intermediate parameter files: `03_imu_temperature_calibration_results.param`, `12_mp_setup_mandatory_hardware.param` and `25_inflight_magnetometer_fit_results.param` are specific to each vehicle instance. All other intermediate parameter files can be used without modifications across all instances (or serial numbers) of the same product model.
+If you are in the business of manufacturing multicopters and maintain **high-quality standards that result in the production of multiple, nearly identical vehicles**, you can reuse most intermediate parameter files across these vehicles.
+Only three intermediate parameter files: `03_imu_temperature_calibration_results.param`, `12_mp_setup_mandatory_hardware.param` and `25_inflight_magnetometer_fit_results.param` are specific to each vehicle instance.
+All other intermediate parameter files can be used without modifications across all instances (or serial numbers) of the same product model.
 
 #### 1. See the Current Vehicle Directory (optional)
 
@@ -251,7 +253,6 @@ After the summary message box is displayed, the application will write the summa
 - `non-default_writable_calibrations.param`: Contains all non-default writable sensor calibration 🟨 parameters. These are non-reusable.
 - `non-default_writable_non-calibrations.param`: Contains all non-default writable non-sensor-calibration parameters. These are reusable across similar vehicles.
 
-
 The summary files provide a clear overview of the changes made.
 
 The files are also automatically zipped into a file with the same name as the vehicle directory, inside the vehicle directory.
diff --git a/credits/idna-LICENSE.md b/credits/idna-LICENSE.md
@@ -1,4 +1,4 @@
-BSD 3-Clause License
+# BSD 3-Clause License
 
 Copyright (c) 2013-2024, Kim Davies and contributors.
 All rights reserved.
diff --git a/install_linux.sh b/install_linux.sh
@@ -43,7 +43,7 @@ if [ -d "$HOME/Desktop" ]; then
     chmod 755 "$HOME/Desktop/ardupilot_methodic_configurator.desktop"
     echo "ardupilot_methodic_configurator.desktop copied to ~/Desktop."
 else
-    echo "~/Desktop directory does not exist. Skipping copy to Desktop."
+    echo "$HOME/Desktop directory does not exist. Skipping copy to Desktop."
 fi
 
 update-desktop-database ~/.local/share/applications/
diff --git a/install_macos.sh b/install_macos.sh
@@ -5,8 +5,9 @@
 #SPDX-License-Identifier: GPL-3.0-or-later
 
 # Use venv if you use python3 due to the PEP668
-python3 -m venv venv
-source venv/bin/activate
+python3 -m venv .venv
+# shellcheck source=/dev/null
+source .venv/bin/activate
 
 # Uninstall serial and pyserial to avoid conflicts
 python3 -m pip uninstall -y serial pyserial
