Merge pull request #783 from derskythe/fix/docs-formating

fix: remove not printable symbols and update FAQ and BadUSB documenta…
DarkFlippers · Jul 27, 2024 · 6a86a13 · 6a86a13
2 parents b604ec6 + 74527d9
commit 6a86a13
Show file tree

Hide file tree

Showing 10 changed files with 597 additions and 558 deletions.
diff --git a/documentation/AppManifests.md b/documentation/AppManifests.md
@@ -16,18 +16,18 @@ Only two parameters are mandatory: **appid** and **apptype**. Others are optiona
 
 - **apptype**: member of FlipperAppType.\* enumeration. Valid values are:
 
-| Enum member | Firmware component type                                                                     |
-| ----------- | ------------------------------------------------------------------------------------------- |
-| SERVICE     | System service, created at early startup                                                    |
-| SYSTEM      | Application is not being shown in any menus. It can be started by other apps or from CLI    |
-| APP         | Regular application for the main menu                                                       |
-| PLUGIN      | Application to be built as a part of the firmware and to be placed in the Plugins menu      |
-| DEBUG       | Application only visible in Debug menu with debug mode enabled                              |
-| ARCHIVE     | One and only Archive app                                                                    |
-| SETTINGS    | Application to be placed in the system settings menu                                        |
-| STARTUP     | Callback function to run at system startup. Does not define a separate app                  |
-| EXTERNAL    | Application to be built as `.fap` plugin                                                    |
-| METAPACKAGE | Does not define any code to be run, used for declaring dependencies and application bundles |
+| Enum member     | Firmware component type                                                                          |
+|:----------------|--------------------------------------------------------------------------------------------------|
+| SERVICE         | System service, created at early startup                                                         |
+| SYSTEM          | Application is not being shown in any menus. It can be started by other apps or from CLI         |
+| APP             | Regular application for the main menu                                                            |
+| PLUGIN          | Application to be built as a part of the firmware and to be placed in the Plugins menu           |
+| DEBUG           | Application only visible in Debug menu with debug mode enabled                                   |
+| ARCHIVE         | One and only Archive app                                                                         |
+| SETTINGS        | Application to be placed in the system settings menu                                             |
+| STARTUP         | Callback function to run at system startup. Does not define a separate app                       |
+| EXTERNAL        | Application to be built as `.fap` plugin                                                         |
+| METAPACKAGE     | Does not define any code to be run, used for declaring dependencies and application bundles      |
 
 - **name**: name displayed in menus.
 - **entry_point**: C function to be used as the application's entry point. Note that C++ function names are mangled, so you need to wrap them in `extern "C"` to use them as entry points.
@@ -43,7 +43,7 @@ Only two parameters are mandatory: **appid** and **apptype**. Others are optiona
 - **targets**: list of strings and target names with which this application is compatible. If not specified, the application is built for all targets. The default value is `["all"]`.
 - **resources**: name of a folder within the application's source folder to be used for packacking SD card resources for this application. They will only be used if application is included in build configuration. The default value is `""`, meaning no resources are packaged.
 
-#### Parameters for external applications
+### Parameters for external applications
 
 The following parameters are used only for [FAPs](./AppsOnSDCard.md):
 
@@ -59,7 +59,10 @@ The following parameters are used only for [FAPs](./AppsOnSDCard.md):
 - **fap_extbuild**: provides support for parts of application sources to be built by external tools. Contains a list of `ExtFile(path="file name", command="shell command")` definitions. `fbt` will run the specified command for each file in the list.
 - **fal_embedded**: boolean, default `False`. Applies only to PLUGIN type. If `True`, the plugin will be embedded into host application's .fap file as a resource and extracted to `apps_assets/APPID` folder on its start. This allows plugins to be distributed as a part of the host application.
 
-Note that commands are executed at the firmware root folder, and all intermediate files must be placed in an application's temporary build folder. For that, you can use pattern expansion by `fbt`: `${FAP_WORK_DIR}` will be replaced with the path to the application's temporary build folder, and `${FAP_SRC_DIR}` will be replaced with the path to the application's source folder. You can also use other variables defined internally by `fbt`.
+> [!NOTE] 
+> These commands are executed at the firmware root folder, and all intermediate files must be placed in an application's temporary build folder. 
+> For that, you can use pattern expansion by `fbt`: `${FAP_WORK_DIR}` will be replaced with the path to the application's temporary build folder, 
+> and `${FAP_SRC_DIR}` will be replaced with the path to the application's source folder. You can also use other variables defined internally by `fbt`.
 
 Example for building an app from Rust sources:
 

diff --git a/documentation/BarcodeGenerator.md b/documentation/BarcodeGenerator.md
@@ -1,15 +1,16 @@
 # This is a UPC-A Barcode Generator for the Flipper Zero hardware.
 
-## Author: [McAzzaMan](https://github.com/McAzzaMan/flipperzero-firmware/tree/UPC-A_Barcode_Generator/applications/barcode_generator)
+> Author: [McAzzaMan](https://github.com/McAzzaMan/flipperzero-firmware/tree/UPC-A_Barcode_Generator/applications/barcode_generator)
 
-<img src=https://i.imgur.com/TDbo1tz.png>
+<img src="https://i.imgur.com/TDbo1tz.png" alt="" />
 
 It will eventually be expanded into other barcode types. It currently only generates UPC-A type barcodes.
 
-<img src=https://i.imgur.com/bxTdzuA.png>
+<img src="https://i.imgur.com/bxTdzuA.png" alt="" />
 
-<b> -Controls- </b> </br>
-Hitting the centre button on the Flipper toggles edit mode.
-When in edit mode, left and right will change the digit to be changed, and up and down will adjust the digit value.
+## Controls
 
-<img src=https://i.imgur.com/lGbzdwH.png>
+Hitting the `centre` button on the Flipper toggles edit mode.
+When in edit mode, `Left` and `Right` will change the digit to be changed, and up and down will adjust the digit value.
+
+<img src="https://i.imgur.com/lGbzdwH.png" alt="" />