Unified formatting and wording across all READMEs #285

Author: TheNinth7

source/README.md

@@ -1,4 +1,4 @@
-# Folder `/source`
+# Folder `source`
 
 This folder contains the source code of the app, written in **Monkey C**, Garmin’s programming language. It uses the Connect IQ SDK for user interface components, application settings, persistent storage, and HTTP communication with the openHAB server.
 
@@ -13,48 +13,38 @@ Two mechanisms are used to tailor the source code for different target devices:
 - The relevant `config` and `theme` directories are added to the device-specific source path in [`monkey.jungle`](../README.md#root-folder-).
 - In the shared `main` source, exclude annotations are used to adapt the code to individual target devices. These annotations are mapped to devices in [`monkey.jungle`](../README.md#root-folder-) and are documented there.
 
-<br>
-
 ### Other Annotations
 
 - `(:glance)` marks code that must be included in the _Glance_ view.
 
-<br>
-
 ### **Inline Documentation**
 
 All `.mc` files include inline comments and documentation describing the purpose and internal workings of each class.
 
-<br>
-
 ### **Further Reading**
 
 - [Connect IQ Core Topics](https://developer.garmin.com/connect-iq/core-topics/)
 - [Connect IQ API Docs](https://developer.garmin.com/connect-iq/api-docs/)
 
 ---
 
-## Folder Structure
+## Subfolders
 
-### Subfolder `config`
+### Subfolder `config/`
 
 This folder defines device-specific configuration using code-based _Constants_, which replace Garmin SDK _Properties_ due to their limitations. Unlike _Properties_, _Constants_ are embedded in the code, update automatically with new app versions, and benefit from compiler validation.
 
 For more details, continue reading the folder’s [README](config/README.md).
 
-<br>
-
-### Subfolder `main`
+### Subfolder `main/`
 
 Contains the core application source code that is shared across all target devices. This includes the data layer, infrastructure and service components, as well as the user interface logic and views.
 
 Although the `main` code is designed to be largely device-agnostic and to rely on `config` and `themes` for device-specific behavior, there are a few places where different implementations are required depending on device characteristics, such as button-based versus touch-based interaction or round versus rectangular displays. In these cases, device-specific code paths are introduced using exclude annotations directly within the source.
 
 For additional details, refer to the folder’s [README](main/README.md).
 
-<br>
-
-### Subfolder `themes`
+### Subfolder `themes/`
 
 Themes define the color schemes used in the app and can change dynamically at runtime. This also includes icons whose colors must be adapted to the active theme. Themes are used to implement the light and dark mode on Edge devices.
 

source/main/README.md

@@ -9,7 +9,7 @@ While most code in this directory is shared, certain parts are conditionally inc
 
 ## Subfolder Structure
 
-### `data/`
+### Subfolder `data/`
 
 Implements the data layer of the application.
 
@@ -24,7 +24,7 @@ For more details, see the folder’s [README](data/README.md).
 
 ---
 
-### `infrastructure/`
+### Subfolder `infrastructure/`
 
 Provides the technical foundation of the application.
 
@@ -34,7 +34,7 @@ For more details, see the folder’s [README](infrastructure/README.md).
 
 ---
 
-### `user-interface/`
+### Subfolder `user-interface/`
 
 Contains all presentation-layer code.
 

source/main/data/communications/README.md

@@ -8,15 +8,15 @@ This folder contains the connection management logic, HTTP request handling and
 
 ## Subfolder Structure
 
-### `connection/`
+### Subfolder `connection/`
 
 Contains the `ConnectionManager`, which tracks the currently available connection type (BLE vs. Wi-Fi) and manages transitions between normal, degraded (Wi-Fi), and offline modes.
 
 For more details on connection behavior, see the [Network Access](https://next.openhab.org/docs/apps/garmin/#network-access) section of the user manual.
 
 ---
 
-### `sync-delegates/`
+### Subfolder `sync-delegates/`
 
 Implements Wi-Fi-based synchronization used when no BLE connection is available.
 
@@ -29,9 +29,7 @@ Sync delegates are responsible for sending commands and updating the sitemap ove
   Introduces SyncDelegate support and provides basic guidance on implementing Wi-Fi synchronization.
 - [Connect IQ API Docs – `Toybox.Communications.SyncDelegate`](https://developer.garmin.com/connect-iq/api-docs/Toybox/Communications/SyncDelegate.html)  
 
-<br>
-
-### `web-requests/`
+### Subfolder `web-requests/`
 
 Implements communication with the openHAB server using the Connect IQ SDK’s `Toybox.Communications` module.
 

source/main/data/sitemap/README.md

@@ -12,15 +12,15 @@ The classes in this folder convert the JSON representation delivered by openHAB
 
 ## Subfolder Structure
 
-### `base/`
+### Subfolder `base/`
 
 Contains `SitemapElement.mc`, the abstract base class for all sitemap elements.
 
 It defines shared properties and common parsing logic used by all concrete sitemap element types.
 
 ---
 
-### `json/`
+### Subfolder `json/`
 
 The Connect IQ API delivers JSON data as a dictionary.  
 `JsonObjectAdapter` provides type-safe accessors for retrieving objects, arrays, strings, numbers, and booleans from the JSON structure.
@@ -29,7 +29,7 @@ This layer isolates JSON handling details from the higher-level sitemap model.
 
 ---
 
-### `pages/`
+### Subfolder `pages/`
 
 Contains classes representing the **content** of container-type sitemap elements (e.g., frames or groups).
 
@@ -39,7 +39,7 @@ To keep the UI responsive and avoid limitations such as the Watchdog timeout for
 
 ---
 
-### `widgets/`
+### Subfolder `widgets/`
 
 Contains `SitemapElement` subclasses representing concrete sitemap widgets, such as switches, sliders, text labels, and container elements.
 

source/main/user-interface/features/README.md

@@ -71,17 +71,17 @@ Device-specific behavior is defined in the `monkey.jungle` build file. Exclusion
 
 ### Subfolders
 
-#### `manager/`
+#### Subfolder `manager/`
 
 Contains `SettingsMenuManager`, which controls the lifecycle and presentation of the settings menu.
 
 It maintains singleton instances of the menu and its input delegate, tracks whether the menu is currently visible, and coordinates transitions between the homepage and the settings view. It also determines focus behavior based on slide direction and input type, and manages pushing and popping the view on the `ViewStack`.
 
-#### `menu/`
+#### Subfolder `menu/`
 
 Contains the `SettingsMenu` implementation based on `BaseMenu`, along with the corresponding input delegates for handling user interaction.
 
-#### `menu-items/`
+#### Subfolder `menu-items/`
 
 Contains the individual menu items displayed within the _Settings_ menu.
 

source/main/user-interface/features/sitemap/control/README.md

@@ -52,15 +52,15 @@ The custom implementation (`DynamicPicker`) allows scrolling through and selecti
 
 ---
 
-## `player/`
+## Subfolder `player/`
 
 Implements `PlayerView`, which enables interaction with media players (play/pause, next/previous) and displays the current playback state.
 
 See the [Player section](https://next.openhab.org/docs/apps/garmin/#player) for usage details and examples.
 
 ---
 
-## `rollershutter/`
+## Subfolder `rollershutter/`
 
 Implements `RollershutterView`, which allows control of a rollershutter (up/down/stop) and displays the current state.