Documentation: update and cleanup (#3934)

* Developers Docs editing

* Logo underline removed

The underline has been removed when hovering over the logo.

* proofread docs

* application -> app in several files

---------

Co-authored-by: knrn64 <25254561+knrn64@users.noreply.github.com>
Co-authored-by: あく <alleteam@gmail.com>

documentation/doxygen/Doxyfile.cfg

@@ -42,7 +42,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "Flipper Zero Firmware"
+PROJECT_NAME           = "Flipper Developer Docs"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version

documentation/doxygen/app_publishing.dox

@@ -0,0 +1,7 @@
+/**
+@page app_publishing Publishing to the Apps Catalog
+
+You can publish your app in the Flipper Apps Catalog. Users will be able to download your app and install it on their Flipper Zero via [mobile apps](https://flpr.app/) and [Flipper Lab](https://lab.flipper.net/apps). Check out the documentation below:
+
+- [Apps Catalog: Contribution Guide](https://github.com/flipperdevices/flipper-application-catalog/blob/main/documentation/Contributing.md) — How to publish and update your app in the Apps Catalog
+*/

documentation/doxygen/applications.dox

@@ -1,12 +1,12 @@
 /**
-@page applications Application Programming
+@page applications App Development
 
-Flipper Zero features full support for custom applications which (usually) do not require any changes to the firmware.
+Flipper Zero features full support for custom apps which (usually) do not require any changes to the firmware.
 
-For easy application development, a software tool called [uFBT](https://github.com/flipperdevices/flipperzero-ufbt) is available.
+For easy app development, a software tool called [uFBT](https://github.com/flipperdevices/flipperzero-ufbt) is available.
 
-- @subpage vscode - Flipper Zero integration for VS Code
-- @subpage apps_on_sd_card - Creating apps that can be dynamically loaded from the SD card
-- @subpage app_manifests - How applications announce themselves to the system
-- @subpage app_examples - Various application examples, complete with the source code
+- @subpage apps_on_sd_card — Creating apps that can be dynamically loaded from the SD card
+- @subpage app_manifests — How apps announce themselves to the system
+- @subpage app_examples — Various app examples, complete with the source code
+- @subpage app_publishing — Learn how to publish and update your app in the Apps Catalog
 */

documentation/doxygen/dev_board.dox

@@ -3,8 +3,8 @@
 
 [ESP32-based development board](https://shop.flipperzero.one/collections/flipper-zero-accessories/products/wifi-devboard).
 
-- @subpage dev_board_get_started - Quick start for new users
-- @subpage dev_board_reading_logs - Find out what is currently happening on the system
-- @subpage dev_board_fw_update - Keep the developer board up to date
+- @subpage dev_board_get_started — Quick start for new users
+- @subpage dev_board_reading_logs — Find out what is currently happening on the system
+- @subpage dev_board_fw_update — Keep the developer board up to date
 
 */

documentation/doxygen/dev_tools.dox

@@ -3,7 +3,8 @@
 
 Hardware and software tools for all kinds of programming.
 
-- @subpage fbt - Official build and deployment tool for Flipper Zero
-- @subpage dev_board - ESP32-based development board
-- @subpage ota_updates - Standalone firmware self-update mechanism
+- @subpage fbt — Official build and deployment tool for Flipper Zero
+- @subpage vscode — Flipper Zero integration for VS Code
+- @subpage dev_board — ESP32-based development board
+- @subpage ota_updates — Standalone firmware self-update mechanism
 */

documentation/doxygen/examples.dox

@@ -1,10 +1,13 @@
 /**
-@page app_examples Application Examples
+@page app_examples App Examples
 
-A collection of examples covering various aspects of application programming for Flipper Zero.
+A collection of examples covering various aspects of app development for Flipper Zero.
 
-- @subpage example_app_images - Using images and icons in an application
-- @subpage example_app_assets - Using application-specific asset folders
-- @subpage example_app_data - Using application-specific data folders
-- @subpage example_thermo - Reading data from a 1-Wire thermometer
+- @subpage example_number_input — Using a simple keyboard that limits user inputs to a full number (integer)
+- @subpage example_app_images — Using images and icons in an app
+- @subpage example_app_assets — Using app-specific asset folders
+- @subpage example_app_data — Using app-specific data folders
+- @subpage example_thermo — Reading data from a 1-Wire thermometer
+
+You can find more app examples in the [repository on GitHub](https://github.com/flipperdevices/flipperzero-firmware/tree/dev/applications/examples).
 */

documentation/doxygen/expansion_modules.dox

@@ -3,6 +3,6 @@
 
 Expansion modules are special pieces of hardware designed to interface with Flipper's GPIO connector, such as the [Video Game Module](https://shop.flipperzero.one/collections/flipper-zero-accessories/products/video-game-module-for-flipper-zero).
 
-- @subpage expansion_protocol - Transport protocol for smart expansion modules
+- @subpage expansion_protocol — Transport protocol for smart expansion modules
 
 */

documentation/doxygen/file_formats.dox

@@ -9,5 +9,6 @@ Descriptions of various file formats used in Flipper Zero, grouped by applicatio
 - @subpage lfrfid_file_format
 - @subpage nfc_file_format
 - @subpage subghz_file_format
+- @subpage heatshrink_file_format
 
 */

documentation/doxygen/header.html

@@ -48,11 +48,11 @@ $extrastylesheet
  <tbody>
  <tr id="projectrow">
   <!--BEGIN PROJECT_LOGO-->
-  <td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"$logosize/></td>
+  <td id="projectlogo"><a style="background: none;" href="index.html"><img alt="Logo" src="$relpath^$projectlogo"$logosize/></a></td>
   <!--END PROJECT_LOGO-->
   <!--BEGIN PROJECT_NAME-->
   <td id="projectalign">
-   <div id="projectname">$projectname<!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
+   <div id="projectname"><a href="index.html">$projectname</a><!--BEGIN PROJECT_NUMBER--><span id="projectnumber">&#160;$projectnumber</span><!--END PROJECT_NUMBER-->
    </div>
    <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
   </td>

documentation/doxygen/index.dox

@@ -1,26 +1,26 @@
 /**
 @mainpage Overview
 
-Welcome to the Flipper Zero Firmware Developer Documentation!
+Welcome to the Flipper Developer Documentation!
 
-This documentation is intended for developers who want to modify the firmware of the Flipper Zero.
+This documentation is intended for developers interested in modifying the Flipper Zero firmware, creating Apps and JavaScript programs, or working on external hardware modules for the device.
 
-If you are looking for the user manual, please visit the [User Documentation](https://docs.flipperzero.one/) instead.
+If you are looking for the user manual, please visit the [User Documentation](https://docs.flipper.net/) instead.
 
-The documentation is divided into several sections, with all of them accessible from the sidebar on the left:
+The documentation is divided into several sections. All of them are accessible from the sidebar on the left:
 
-- @ref applications - Writing applications for Flipper Zero
-- @ref system - Understanding the firmware's internals
-- @ref file_formats - Saving and loading data to and from files
-- @ref dev_tools - Hardware and software tools for all kinds of programming
-- @ref expansion - Additional modules to expand Flipper's consciousness
-- @ref misc - Various useful pieces of information
-- @ref js - JS-based scripting engine documentation
+- @ref dev_tools — Hardware and software tools for all kinds of programming
+- @ref system — Understanding the firmware's internals
+- @ref applications — Developing apps for Flipper Zero
+- @ref js — JS-based scripting engine
+- @ref expansion — Additional modules to expand Flipper's consciousness
+- @ref file_formats — Saving and loading data to and from files
+- @ref misc — Various useful pieces of information
 
-Aside from the manually-written documentation files, there's also a few automatically-generated ones at the bottom of the sidebar:
+These sections are all manually written. There are also a few automatically generated ones at the bottom of the sidebar:
 
-- [Data Structures](annotated.html) - Every data structure in a list
-- [Files](files.html) - Source file tree with easy navigation
+- [Data Structures](annotated.html) — Every data structure in a list
+- [Files](files.html) — Source file tree with easy navigation
 
 These are generated from the source code and are useful for quickly finding the source code or API documentation for a particular function or data structure.
 */

documentation/doxygen/js.dox

@@ -1,21 +1,22 @@
 /**
 @page js JavaScript
 
-This page contains some information on the Flipper Zero scripting engine, which is based on a modified mJS library
+This page contains some information on the Flipper Zero scripting engine, which is based on a modified mJS library.
 
 - [Brief mJS description](https://github.com/cesanta/mjs/blob/master/README.md)
 - @subpage js_data_types
 - @subpage js_builtin
 
-JavaScript Modules
-JS modules use the Flipper app plugin system. Each module is compiled into a .fal library file and is located on a microSD card. Here is a list of implemented modules:
+## JavaScript modules
 
-- @subpage js_badusb - BadUSB module
-- @subpage js_serial - Serial module
-- @subpage js_math - Math module
-- @subpage js_dialog - Dialog module
-- @subpage js_submenu - Submenu module
-- @subpage js_textbox - Textbox module
-- @subpage js_notification - Notifications module
+JS modules use the Flipper app plugin system. Each module is compiled into a `.fal` library file and is located on a microSD card. Here is a list of implemented modules:
+
+- @subpage js_badusb — BadUSB module
+- @subpage js_serial — Serial module
+- @subpage js_math — Math module
+- @subpage js_dialog — Dialog module
+- @subpage js_submenu — Submenu module
+- @subpage js_textbox — Textbox module
+- @subpage js_notification — Notifications module
 
 */

documentation/doxygen/misc.dox

@@ -3,7 +3,7 @@
 
 Various pieces of information that do not fall into other categories.
 
-- @subpage lfrfid_raw - Collecting raw data from LFRFID tags
-- @subpage key_combos - Different key combination shortcuts for Flipper Zero
-- @subpage universal_remotes - Creating and improving IR universal remote libraries
+- @subpage lfrfid_raw — Collecting raw data from LF RFID tags
+- @subpage key_combos — Different key combination shortcuts for Flipper Zero
+- @subpage universal_remotes — Creating and improving IR universal remote libraries
 */

documentation/doxygen/system.dox

@@ -1,13 +1,13 @@
 /**
 @page system System Programming
 
-Lower level aspects of software development for Flipper Zero.
+Lower-level aspects of software development for Flipper Zero.
 
-- @subpage unit_tests - Automated testing, a crucial part of the development process
-- @subpage furi_check - Hard checks for exceptional situations
-- @subpage furi_hal_bus - Access the on-chip peripherals in a safe way
-- @subpage furi_hal_debugging - Low level debugging features
-- @subpage hardware_targets - Support for different hardware platforms
-- @subpage firmware_assets - Various files required for building the firmware
-- @subpage dolphin_assets - Animations for the Dolphin game
+- @subpage unit_tests — Automated testing, a crucial part of the development process
+- @subpage furi_check — Hard checks for exceptional situations
+- @subpage furi_hal_bus — Access the on-chip peripherals in a safe way
+- @subpage furi_hal_debugging — Low-level debugging features
+- @subpage hardware_targets — Support for different hardware platforms
+- @subpage firmware_assets — Various files required for building the firmware
+- @subpage dolphin_assets — Animations for the Dolphin game
 */