Add settings guide

app/src/main/java/com/kylecorry/trail_sense/settings/ui/ThermometerSettingsFragment.kt

@@ -179,7 +179,7 @@ class ThermometerSettingsFragment : AndromedaPreferenceFragment() {
         }
 
         onClick(preference(R.string.pref_thermometer_user_guide_button)){
-            UserGuideUtils.showGuide(this, R.raw.guide_settings_thermometer)
+            UserGuideUtils.showGuide(this, R.raw.guide_tool_settings)
         }
     }
 

app/src/main/java/com/kylecorry/trail_sense/tools/guide/infrastructure/Guides.kt

@@ -47,23 +47,6 @@ object Guides {
                 guides
             )
         }
-
-        val settings = UserGuideCategory(
-            context.getString(R.string.settings),
-            listOfNotNull(
-                if (Sensors.hasBarometer(context)) UserGuide(
-                    context.getString(R.string.barometer),
-                    null,
-                    R.raw.guide_settings_barometer
-                ) else null,
-                UserGuide(
-                    context.getString(R.string.tool_thermometer_title),
-                    null,
-                    R.raw.guide_settings_thermometer
-                ),
-            )
-        )
-
         val general = listOf(
             UserGuideCategory(
                 context.getString(R.string.general),
@@ -77,6 +60,6 @@ object Guides {
             )
         )
 
-        return general + toolGuides + settings
+        return general + toolGuides
     }
 }

app/src/main/java/com/kylecorry/trail_sense/tools/tools/ui/Tools.kt

@@ -506,6 +506,7 @@ object Tools {
                 R.drawable.ic_settings,
                 R.id.action_settings,
                 ToolCategory.Other,
+                guideId = R.raw.guide_tool_settings
             ),
             Tool(
                 USER_GUIDE,

app/src/main/res/raw/guide_tool_settings.md

@@ -0,0 +1,111 @@
+## Units
+The units can be adjusted in Settings > Units. By default, the units are set based on your device's language settings.
+
+- **Distance**: The unit to display distance measurements.
+- **Pressure**: The unit to display barometric pressure measurements.
+- **Temperature**: The unit to display temperature measurements.
+- **Weight**: The unit to display weight measurements.
+- **Coordinate format**: The format to display geographic coordinates.
+- **Location share map**: The link to use when sharing a location.
+- **Use 24-hour format**: Whether to use a 24-hour clock.
+- **Add leading zero to time**: Whether to add a leading zero to the time (ex. 01:00 instead of 1:00).
+
+## Sensors > Barometer
+The barometer is used to measure air pressure. It can be used to predict the weather or determine your altitude. To adjust barometer settings, go to Trail Sense Settings > Sensors > Barometer.
+
+If you have the Weather Monitor (see the Weather tool) enabled, you will see a chart of the barometric pressure history as recorded by your device. The colored line represents the calibrated pressure while the gray line represents the raw pressure. When you adjust the settings, the chart will update to show the new calibrated pressure. The goal is to have the colored line smoothly follow the gray line.
+
+### Sea level pressure
+Barometric pressure changes with altitude, which makes it difficult to compare pressure readings from different locations. To make pressure readings more consistent, enable the "Sea level pressure" setting. This will adjust the pressure reading to what it would be at sea level. Using this setting will increase the accuracy of weather predictions.
+
+### Smoothing
+To reduce noise in pressure readings, increase the smoothing setting. A value of around 15% is recommended. However, if you increase the smoothing too much, Trail Sense may ignore real pressure changes.
+
+### Factor in temperature
+To get a more accurate pressure reading, you can factor in the temperature. This will make the reading more prone to noise from your phone's thermometer, but it will also give you a more accurate reading of the actual air pressure.
+
+## Sensors > Thermometer
+Thermometer settings can be found in Trail Sense Settings > Sensors > Thermometer.
+
+### Source
+On most phones, you should use this historic temperature source as it will be more accurate.
+
+- **Historic** temperature is estimated from 30 years of historical data. It's usually accurate, but not during extreme weather. You can calibrate it if it's wrong for your location.
+- **Sensor** temperature is read from the phone's built-in thermometer. It's often inaccurate because it's affected by the phone's CPU and battery. You can calibrate it to improve its accuracy. If you power off your phone for a while, you will get a more accurate reading from the sensor.
+
+### Smoothing
+To reduce noise in temperature readings, you can increase the smoothing setting. If using the historic temperature source, this is normally not needed.
+
+If the Weather Monitor (see the Weather tool) is enabled, you will see a chart of the temperature history as recorded by your device. The colored line represents the calibrated temperature while the gray line represents the raw temperature. When you adjust the settings, the chart will update to show the new calibrated temperature. The goal is to have the colored line smoothly follow the gray line.
+
+#### Updating recorded temperatures
+
+If you change the temperature source to "Historic", you can choose to update all previously recorded temperatures. This will replace the old temperatures with the estimated temperature from the historic data. This is useful if you previously recorded temperatures with the sensor and then switched to historic temperatures.
+
+### Calibrating
+
+1. Reset the thermometer calibration in Trail Sense.
+2. Put your phone in a cold place for 10 minutes.
+3. Note the temperature shown in Trail Sense as the minimum phone temperature.
+4. Note the actual temperature of the cold place using an actual thermometer.
+5. Put your phone in a warm place for 10 minutes.
+6. Note the temperature shown in Trail Sense as the maximum phone temperature.
+7. Note the actual temperature of the warm place using an actual thermometer.
+8. Go to the Thermometer sensor settings in Trail Sense and enter the minimum and maximum temperatures you recorded, along with the actual temperatures you recorded.
+
+**Caution:** Refer to your phone's manual to identify the designed operating temperatures, do not exceed these when performing calibration.
+
+## Privacy
+Privacy settings can be adjusted in Settings > Privacy.
+
+- **Location**: Clicking this will take you to the GPS settings, where you can choose to use a mocked location.
+- **Prevent screenshots**: Prevents screenshots from being taken while the app is open.
+
+**Note**: Trail Sense does not use the Internet and all data is stored locally on your device.
+
+## Errors
+Some tools such as Navigation and Astronomy display error banners at the top of the screen. These banners can be disabled in Settings > Errors.
+
+- **Compass unavailable**: The compass is not available on your device.
+- **GPS unavailable**: The GPS is not available on your device.
+- **Location not set**: The location is mocked but has not been set (uses 0, 0).
+- **Compass accuracy**: The compass accuracy is low.
+- **GPS timeouts**: The GPS has timed out and was unable to determine your location.
+
+## Experimental
+Experimental features can be enabled in Settings > Experimental. These features are not ready for general use and may not work as expected.
+
+## Backup / Restore
+When switching to a new device or reinstalling the app, it may be helpful to backup your data and settings. This can be done in Settings > Backup / Restore.
+
+- **Backup**: Creates a backup of your data and settings. This will save as a zip file which is unencrypted and contains location data, so only send it to people you trust.
+- **Restore**: Restores a backup of your data and settings. This will permanently overwrite your current data and settings. You can restore from an older version of the app, but cannot restore from a newer version.
+
+## Tools
+Settings for each tool can be adjusted in the Settings > Tools section. For more information, see the guide for each tool.
+
+## Theme
+Theme related settings can be adjusted in Settings > Theme.
+
+- **Theme**: The theme to use for the app.
+  - **Light**: A theme with a white background.
+  - **Dark**: A theme with a dark background.
+  - **Black**: A theme with a black background.
+  - **System**: A theme that follows the system settings.
+  - **Sunrise/sunset**: A theme that changes between light and dark based on the time of day.
+  - **Night**: A theme with a black background and a red filter to help maintain night vision.
+- **Dynamic Colors**: Whether to use your device's dynamic colors in the app, if disabled or unavailable colors in Trail Sense will be a shade of orange.
+- **Compass Dynamic Colors**: Whether to use your device's dynamic colors in the compass (cardinal directions and certain markers on maps).
+- **Compact Mode**: Whether to use a more compact layout for the bottom bar (thinner and does not display labels).
+
+## Diagnostics
+If you are having issues with the app, you can view diagnostic information in Settings > Diagnostics. This feature runs some checks and clicking on each failed check will provide more information on how to resolve the issue and what is impacted.
+
+## About
+You can find additional information about Trail Sense in Settings > About.
+
+- **Version**: The version of the app you are using.
+- **Privacy policy**: A link to the privacy policy.
+- **Email developer**: A link to send an email to the developer for feedback or support.
+- **GitHub**: A link to the GitHub repository (source code) for Trail Sense.
+- **Licenses**: A list of open source licenses used in Trail Sense.

site/guides.js

@@ -25,6 +25,7 @@ const guides = [
   "tool_recommended_apps",
   "tool_ruler",
   "tool_sensors",
+  "tool_settings",
   "tool_solar_panel_aligner",
   "tool_tools",
   "tool_temperature_estimation",
@@ -33,9 +34,7 @@ const guides = [
   "tool_water_boil_timer",
   "tool_weather",
   "tool_whistle",
-  "tool_white_noise",
-  "settings_barometer",
-  "settings_thermometer",
+  "tool_white_noise"
 ];
 
 // Populate the guide list