Skip to content

Commit

Permalink
Add tools guide
Browse files Browse the repository at this point in the history
  • Loading branch information
kylecorry31 committed Dec 22, 2023
1 parent 32deedf commit 60f800d
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,19 @@ object Guides {
)
)

return toolGuides + sensors
val general = listOf(
UserGuideCategory(
context.getString(R.string.general),
listOf(
UserGuide(
context.getString(R.string.tools),
null,
R.raw.guide_tool_tools
)
)
)
)

return general + toolGuides + sensors
}
}
2 changes: 1 addition & 1 deletion app/src/main/res/raw/guide_tool_sensors.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The Sensors tool can be used to test the sensors on your device.

## Sensor List
The sensor list shows all sensors available on your device that Trail Sense uses. If the accuracy of the sensor is available, it will be shown on the left, and the sensor's value will appear to the right of that.
The sensor list shows all the sensors available on your device that Trail Sense uses. If the accuracy of the sensor is available, it will be shown on the left, and the sensor's value will appear to the right of that.
39 changes: 39 additions & 0 deletions app/src/main/res/raw/guide_tool_tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
Trail Sense is composed of a number of tools that are designed for hiking, backpacking, camping, and geocaching.

## Bottom Navigation
The Navigation, Weather (if available), and Astronomy tools are available in the bottom navigation bar. These tools are also available in the tool list.

All other tools can be found in the Tools bottom navigation item on the far right.

## Tool List
The tool list can be accessed by tapping the Tools item in the bottom navigation bar. This will show a list of all tools available in Trail Sense.

Clicking on a tool will open it.

You can also long-press on a tool to see more options:
- **About**: Provides more details about what the tool does.
- **Pin/Unpin**: Allows you to pin the tool to the top of the list.
- **User Guide**: Opens the user guide for the tool.
- **Experimental**: This will show tools that are still in development. These tools may not be fully functional. You can enable experimental tools in Settings > Experimental.

## Pinned Tools
You can pin tools to the top of the tool list by long-pressing on a tool and selecting 'Pin'. This will make the tool appear at the top of the tool list. You can unpin a tool by long-pressing on it and selecting 'Unpin'.

You can also pin/unpin tools in bulk by tapping the edit icon to the right of the pinned tools header.

## Sorting Tools
You can change the order of the tools by clicking the sort icon to the right of the tools header. This will allow you to sort by:
- **Name**: Sorts alphabetically by tool name.
- **Category**: Groups tools by category and sorts alphabetically within each category.

## Search
You can search for a specific tool using the search bar at the top of the tool list.

## User Guide
A user guide is available for each tool. You can access the user guide by long-pressing on a tool and selecting 'User Guide'. You can also access the user guide by opening the 'User Guide' tool in the tool list.

## Settings
You can access the app settings by tapping the settings icon in the top right corner of the tool list. You can also access the settings by opening the 'Settings' tool in the tool list.

## Quick Actions
You can enable quick actions at the top of the tool list in Settings > 'Tool quick actions'. You can find more information about each quick action by viewing the user guide for its respective tool.
1 change: 1 addition & 0 deletions site/guides.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ const guides = [
'tool_ruler',
'tool_sensors',
'tool_solar_panel_aligner',
'tool_tools',
'tool_temperature_estimation',
'tool_tides',
'tool_triangulate_location',
Expand Down

0 comments on commit 60f800d

Please sign in to comment.