IMPROVEMENT: more markdownlint fixes

Author: amilcarlucas

.markdownlint.yaml

@@ -6,7 +6,7 @@ no-trailing-punctuation: false
 no-inline-html:
   enabled: false
 MD013:
-  line_length: 500
+  line_length: 170
   code_blocks: false
   tables: false
   headers: false

ARCHITECTURE.md

@@ -13,7 +13,11 @@ It was augmented with [DevOps](https://en.wikipedia.org/wiki/DevOps) and [CI/CD
 
 ### Requirements analysis
 
-We collected and analyzed the needs of the ArduPilot users:
+We collected and analyzed the needs of the ArduPilot users by
+[reading 108K+ forum posts](https://discuss.ardupilot.org/u?order=likes_received&period=all),
+by reading [Ardupilot FW issues on github](https://github.com/ArduPilot/ardupilot/issues),
+by reading the [ArduPilot documentation](https://ardupilot.org/ardupilot/),
+by attending the weekly ArduPilot developers meeting and by participating in forum discussions:
 
 - guidelines on how to correctly build the vehicle, many users are not aware of the hardware basics.
 - a non-trial and error approach to set the [1300 ArduPilot parameters](https://ardupilot.org/copter/docs/parameters.html)
@@ -25,7 +29,7 @@ We collected and analyzed the needs of the ArduPilot users:
   - to understand why decisions where made and their implications
 
 Then we developed, documented and tested the *clear sequence of steps to take to configure the vehicle* in the
-[How to methodically tune any ArduCopter](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduCopter) guide.
+[How to methodically tune any ArduCopter](https://ardupilot.github.io/MethodicConfigurator/TUNING_GUIDE_ArduCopter) guide in Dec 2023.
 Once that was mostly done we proceeded with *system design* the next step of the V-model.
 
 ### System design
@@ -41,7 +45,8 @@ the following system design requirements were derived:
 - The "partial/intermediate" parameter files must have meaningful names
 - The sequence of the "partial/intermediate" parameter files must be clear
 - Users should be able to upload all parameters from a "partial/intermediate" parameter file to the flight controller and advance to the next intermediate parameter file.
-- Users should be able to upload a subset of parameters from a "partial/intermediate" parameter file to the flight controller and advance to the next intermediate parameter file.
+- Users should be able to upload a subset of parameters from a "partial/intermediate" parameter file to the flight controller
+  and advance to the next "partial/intermediate" parameter file in the configuration sequence.
 - Users should be able to select a "partial/intermediate" parameter file from a list of available files and select the one to be used.
 - The software must display a table of parameters with columns for:
   - the parameter name,
@@ -55,8 +60,9 @@ the following system design requirements were derived:
 
 #### 2. Communication Protocols
 
-- The software must support communication with the drone's flight controller using [MAVlink](https://mavlink.io/en/).
-- Use either [parameter protocol](https://mavlink.io/en/services/parameter.html) or [FTP-over-MAVLink](https://mavlink.io/en/services/ftp.html) protocols.
+- The software must support communication with the drone's flight controller using [MAVlink](https://mavlink.io/en/):
+  - [parameter protocol](https://mavlink.io/en/services/parameter.html) or
+  - [FTP-over-MAVLink](https://mavlink.io/en/services/ftp.html) protocols.
 - The software must automatically reset the ArduPilot if required by the changes made to the parameters.
   - parameters ending in "_TYPE", "_EN", "_ENABLE", "SID_AXIS" require a reset after being changed
 - The software must automatically validate if the parameter was correctly uploaded to the flight controller
@@ -155,7 +161,8 @@ It consists of four main components:
 ![Software Architecture diagram](images/Architecture.drawio.png)
 
 The parts can be individually tested, and do have unit tests.
-They can also be exchanged, for instance, [tkinter-frontend](https://docs.python.org/3/library/tkinter.html) can be replaced with [wxWidgets](https://www.wxwidgets.org/) or [pyQt](https://riverbankcomputing.com/software/pyqt/intro).
+They can also be exchanged, for instance, [tkinter-frontend](https://docs.python.org/3/library/tkinter.html) can be replaced with
+[wxWidgets](https://www.wxwidgets.org/) or [pyQt](https://riverbankcomputing.com/software/pyqt/intro).
 
 In the future, we might port the entire application into a client-based web application.
 That way the users would not need to install the software and will always use the latest version.
@@ -268,7 +275,8 @@ python insert_translations.py --lang-code=de
 
 ### 6. Translate the Strings
 
-Open the `ardupilot_methodic_configurator.po` file in a text editor or a specialist translation tool (e.g., [Poedit](https://poedit.net/)). You will see the extracted strings, which you can begin translating.
+Open the `ardupilot_methodic_configurator.po` file in a text editor or a specialist translation tool (e.g., [Poedit](https://poedit.net/)).
+You will see the extracted strings, which you can begin translating.
 
 Each entry will look like this:
 
@@ -323,6 +331,7 @@ Update the software's configuration to set the desired language and run the appl
 
 ### 9. Review and Refine
 
-Once the new language is running in the software, review the translations within the application for clarity and correctness. Make adjustments as needed in the `.po` file and recompile to an `.mo` file.
+Once the new language is running in the software, review the translations within the application for clarity and correctness.
+Make adjustments as needed in the `.po` file and recompile to an `.mo` file.
 
 Following these steps should enable you to successfully add support for any new translation language within the Ardupilot Methodic Configurator.

CONTRIBUTING.md

@@ -48,9 +48,14 @@ for new users to prevent off-topic discussion.
 
 ## How to make a good bug report
 
-* Make sure your bug is not a support issue. Support issues should go to [the support forums](http://discuss.ardupilot.org/t/new-ardupilot-methodic-configurator-gui/115038/1) and include a `.bin` log file and a `.zip` file with all the intermediate `.param` files if possible. If you're not sure you have a bug, you should seek support first.
-* Search for your bug, and make sure it is [not already reported](https://github.com/ArduPilot/MethodicConfigurator/issues). If it is already reported, comment on that issue.
+* Make sure your bug is not a support issue.
+  Support issues should go to [the support forums](http://discuss.ardupilot.org/t/new-ardupilot-methodic-configurator-gui/115038/1) and
+  include a `.bin` log file and a `.zip` file with all the intermediate `.param` files if possible.
+  If you're not sure you have a bug, you should seek support first.
+* Search for your bug, and make sure it is [not already reported](https://github.com/ArduPilot/MethodicConfigurator/issues).
+  If it is already reported, comment on that issue.
 * Only report one bug per issue report.
 * Write a clear and concise summary. Be specific about what component of the software you are writing about, and follow the convention: "Copter: blah blah blah"
-* Write a clear and concise description, with **particularly clear steps** to reproduce the problem. Include logs that display the bug. **Try to report only facts in your issue report, keeping your assumptions out of it.**
+* Write a clear and concise description, with **particularly clear steps** to reproduce the problem.
+  Include logs that display the bug. **Try to report only facts in your issue report, keeping your assumptions out of it.**
 * The majority of issues open now are good or acceptable by these guidelines. Please refer to them for examples.

QUICKSTART.md

@@ -31,7 +31,8 @@ To methodically build, configure and tune ArduPilot vehicles follow this sequenc
 
 The software needs this information to automatically pre-select configuration settings relevant to your specific vehicle
 
-- [Start the ArduPilot Methodic Configurator and input select a vehicle that resembles yours](#5-use-the-ardupilot-methodic-configurator-software-for-the-first-time) and input vehicle components and component connections information into the ArduPilot Methodic Configurator *component editor window*
+- [Start the ArduPilot Methodic Configurator and input select a vehicle that resembles yours](#5-use-the-ardupilot-methodic-configurator-software-for-the-first-time)
+  and input vehicle components and component connections information into the ArduPilot Methodic Configurator *component editor window*
 
 ### 1.4 Perform IMU temperature calibration before assembling the autopilot into the vehicle (optional)
 
@@ -48,7 +49,8 @@ Assemble and connect all components. Make sure you [follow best practices](TUNIN
 
 ### 1.6 Basic mandatory configuration
 
-Again using the [*ArduPilot Methodic configurator* software GUI](#7-use-the-ardupilot-methodic-configurator-software-after-having-created-a-vehicle-from-a-template) perform the following steps:
+Again using the [*ArduPilot Methodic configurator* software GUI](#7-use-the-ardupilot-methodic-configurator-software-after-having-created-a-vehicle-from-a-template)
+perform the following steps:
 
 - [04_board_orientation.param](TUNING_GUIDE_ArduCopter.md#61-configure-flight-controller-orientation) flight controller orientation
 - [05_remote_controller.param](TUNING_GUIDE_ArduCopter.md#62-configure-the-rc-receiver) remote controller connections and protocol
@@ -82,24 +84,36 @@ These are the very [minimum tuning steps](TUNING_GUIDE_ArduCopter.md#8-minimalis
 
 - Load the `.bin` log file from the first flight into [Notch filter webtool](https://firmware.ardupilot.org/Tools/WebTools/FilterReview/)
 - [19_notch_filter_results.param](TUNING_GUIDE_ArduCopter.md#81-notch-filter-calibration) use the webtool information to configure the notch filter(s)
-- [20_throttle_controller.param](TUNING_GUIDE_ArduCopter.md#82-configure-the-throttle-controller) the altitude controller depends on the power-to-thrust ratio found in the first flight
+- [20_throttle_controller.param](TUNING_GUIDE_ArduCopter.md#82-configure-the-throttle-controller) the altitude controller depends on the
+  power-to-thrust ratio found in the first flight
 - [21_ekf_config.param](TUNING_GUIDE_ArduCopter.md#83-configure-the-ekf-altitude-source-weights) sometimes the EKF3 needs a tune to maintain altitude
-- [22_quick_tune_setup.param](TUNING_GUIDE_ArduCopter.md#84-second-flight-pid-vtol-quiktune-lua-script-or-manual-pid-tune) and [23_quick_tune_results.param](TUNING_GUIDE_ArduCopter.md#84-second-flight-pid-vtol-quiktune-lua-script-or-manual-pid-tune) You need lua scripting support to do this if not available you can tune manually.
+- [22_quick_tune_setup.param](TUNING_GUIDE_ArduCopter.md#84-second-flight-pid-vtol-quiktune-lua-script-or-manual-pid-tune) and
+  [23_quick_tune_results.param](TUNING_GUIDE_ArduCopter.md#84-second-flight-pid-vtol-quiktune-lua-script-or-manual-pid-tune),
+  you need lua scripting support to do this if not available you can tune manually.
 
 That is it, if you are impatient and do not want an optimized vehicle you can skip to [everyday use](#113-everyday-use).
 
 ### 1.9 Standard tuning (optional)
 
 These are the [standard tuning steps](TUNING_GUIDE_ArduCopter.md#9-standard-tuning-optional) required for an optimized flight:
 
-- [24_inflight_magnetometer_fit_setup.param](TUNING_GUIDE_ArduCopter.md#91-third-flight-magfit) Use lua scripted flight path or fly manually and  [25_inflight_magnetometer_fit_results.param](TUNING_GUIDE_ArduCopter.md#912-calculate-inflight-magfit-calibration) Use the [magfit webtool](https://firmware.ardupilot.org/Tools/WebTools/MAGFit/) to calculate a file that the ardupilot methodic configurator can use
-- [26_quick_tune_setup.param](TUNING_GUIDE_ArduCopter.md#921-setup-quicktune) and [27_quick_tune_results.param](TUNING_GUIDE_ArduCopter.md#922-store-quicktune-results-to-file) Redo quick-tune now that the compass magnetic interference is fully calibrated
-- [28_evaluate_the_aircraft_tune_ff_disable.param](TUNING_GUIDE_ArduCopter.md#93-fifth-flight-evaluate-the-aircraft-tune---part-1) and [29_evaluate_the_aircraft_tune_ff_enable.param](TUNING_GUIDE_ArduCopter.md#94-sixth-flight-evaluate-the-aircraft-tune---part-2)
-- [30_autotune_roll_setup.param](TUNING_GUIDE_ArduCopter.md#95-autotune-flights) and [31_autotune_roll_results.param](TUNING_GUIDE_ArduCopter.md#951-roll-axis-autotune) tune roll axis rate and angle PIDs
-- [32_autotune_pitch_setup.param](TUNING_GUIDE_ArduCopter.md#952-pitch-axis-autotune) and [33_autotune_pitch_results.param](TUNING_GUIDE_ArduCopter.md#952-pitch-axis-autotune) tune pitch axis rate and angle PIDs
-- [34_autotune_yaw_setup.param](TUNING_GUIDE_ArduCopter.md#953-yaw-axis-autotune) and [35_autotune_yaw_results.param](TUNING_GUIDE_ArduCopter.md#953-yaw-axis-autotune) tune yaw axis rate and angle PIDs
-- [36_autotune_yawd_setup.param](TUNING_GUIDE_ArduCopter.md#954-yaw-d-axis-autotune-optional) and [37_autotune_yawd_results.param](TUNING_GUIDE_ArduCopter.md#954-yaw-d-axis-autotune-optional) tune yawd axis rate and angle PIDs
-- [38_autotune_roll_pitch_retune_setup.param](TUNING_GUIDE_ArduCopter.md#955-roll-and-pitch-axis-re-autotune) and [39_autotune_roll_pitch_retune_results.param](TUNING_GUIDE_ArduCopter.md#955-roll-and-pitch-axis-re-autotune) re-tune roll and pitch pitch axis rate and angle PIDs
+- [24_inflight_magnetometer_fit_setup.param](TUNING_GUIDE_ArduCopter.md#91-third-flight-magfit), use lua scripted flight path or fly manually, store the results using
+  [25_inflight_magnetometer_fit_results.param](TUNING_GUIDE_ArduCopter.md#912-calculate-inflight-magfit-calibration), use the
+  [magfit webtool](https://firmware.ardupilot.org/Tools/WebTools/MAGFit/) to calculate a file that the ardupilot methodic configurator can use
+- [26_quick_tune_setup.param](TUNING_GUIDE_ArduCopter.md#921-setup-quicktune) and
+  [27_quick_tune_results.param](TUNING_GUIDE_ArduCopter.md#922-store-quicktune-results-to-file) Redo quick-tune now that the compass magnetic interference is fully calibrated
+- [28_evaluate_the_aircraft_tune_ff_disable.param](TUNING_GUIDE_ArduCopter.md#93-fifth-flight-evaluate-the-aircraft-tune---part-1) and
+  [29_evaluate_the_aircraft_tune_ff_enable.param](TUNING_GUIDE_ArduCopter.md#94-sixth-flight-evaluate-the-aircraft-tune---part-2)
+- [30_autotune_roll_setup.param](TUNING_GUIDE_ArduCopter.md#95-autotune-flights) and
+  [31_autotune_roll_results.param](TUNING_GUIDE_ArduCopter.md#951-roll-axis-autotune) tune roll axis rate and angle PIDs
+- [32_autotune_pitch_setup.param](TUNING_GUIDE_ArduCopter.md#952-pitch-axis-autotune) and
+  [33_autotune_pitch_results.param](TUNING_GUIDE_ArduCopter.md#952-pitch-axis-autotune) tune pitch axis rate and angle PIDs
+- [34_autotune_yaw_setup.param](TUNING_GUIDE_ArduCopter.md#953-yaw-axis-autotune) and
+  [35_autotune_yaw_results.param](TUNING_GUIDE_ArduCopter.md#953-yaw-axis-autotune) tune yaw axis rate and angle PIDs
+- [36_autotune_yawd_setup.param](TUNING_GUIDE_ArduCopter.md#954-yaw-d-axis-autotune-optional) and
+  [37_autotune_yawd_results.param](TUNING_GUIDE_ArduCopter.md#954-yaw-d-axis-autotune-optional) tune yawd axis rate and angle PIDs
+- [38_autotune_roll_pitch_retune_setup.param](TUNING_GUIDE_ArduCopter.md#955-roll-and-pitch-axis-re-autotune) and
+  [39_autotune_roll_pitch_retune_results.param](TUNING_GUIDE_ArduCopter.md#955-roll-and-pitch-axis-re-autotune) re-tune roll and pitch pitch axis rate and angle PIDs
 
 Now the standard tuning is complete you can skip to [everyday use](#113-everyday-use)
 

USECASES.md

@@ -9,9 +9,10 @@ Hence the two main use cases are:
 
 But there are other use cases as well:
 
-1. [Create a vehicle configuration based on a correctly configured vehicle](#create-a-vehicle-configuration-based-on-a-correctly-configured-vehicle)
-1. [Review and or edit configuration files without having the vehicle FC](#review-and-or-edit-configuration-files-without-having-the-vehicle-fc)
-1. [Use the correct default values](#use-the-correct-default-values)
+- [Ardupilot Methodic Configurator use cases](#ardupilot-methodic-configurator-use-cases)
+  - [Create a vehicle configuration based on a correctly configured vehicle](#create-a-vehicle-configuration-based-on-a-correctly-configured-vehicle)
+  - [Review and or edit configuration files without having the vehicle FC](#review-and-or-edit-configuration-files-without-having-the-vehicle-fc)
+  - [Use the correct default values](#use-the-correct-default-values)
 
 ## Create a vehicle configuration based on a correctly configured vehicle
 
@@ -56,7 +57,8 @@ If something is not clear, read the [ArduPilot Methodic Configurator user manual
 If issues are found the problematic fields' background will be marked in red color.
 Correct those entries and press the `Save data and start configuration` button again.
 1. You should now see the *Parameter file editor and uploader* window.
-![AMC parameter file editor and uploader](images/App_screenshot2.png) the `Upload selected params to FC, and advance to next param file` button will be grayed out because there is no FC connected.
+![AMC parameter file editor and uploader](images/App_screenshot2.png) the `Upload selected params to FC, and advance to next param file`
+button will be grayed out because there is no FC connected.
 1. Follow the procedure to [configure the vehicle parameters](QUICKSTART.md#6-configure-the-vehicles-parameters-in-a-traceable-way)
 
 If something is not clear, read the [ArduPilot Methodic Configurator user manual](USERMANUAL.md)