Skip to content

Commit

Permalink
Add user guide for turn back tool
Browse files Browse the repository at this point in the history
  • Loading branch information
kylecorry31 committed Apr 28, 2024
1 parent 18632d9 commit ac8c845
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ object TurnBackToolRegistration : ToolRegistration {
R.drawable.ic_undo,
R.id.turnBackFragment,
ToolCategory.Time,
guideId = R.raw.guide_tool_turn_back,
notificationChannels = listOf(
ToolNotificationChannel(
TurnBackAlarmReceiver.NOTIFICATION_CHANNEL_ID,
Expand Down
12 changes: 12 additions & 0 deletions app/src/main/res/raw/guide_tool_turn_back.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
The Turn Back tool can be used to alert you when to turn back on a hike to return at a specific time.

## Return time
You can set the return time by clicking the input field and selecting a time from the time picker. The return time is the time that you want to return back to your current location if you start the hike now.

Once the return time has been set, an alert will be displayed a little before halfway through the hike to remind you to turn back if you want to return on time. The time until the turn back time is displayed at the top of the screen.

### Return before dark
If you click the "Return before dark" button, the return time will be set to sunset. This is useful if you want to make sure you return before it gets dark.

## Cancel the alert
You can cancel the alert by clicking the "Cancel" button at the bottom of the screen. This will clear the return time and the alert.
12 changes: 12 additions & 0 deletions guides/en-US/guide_tool_turn_back.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
The Turn Back tool can be used to alert you when to turn back on a hike to return at a specific time.

## Return time
You can set the return time by clicking the input field and selecting a time from the time picker. The return time is the time that you want to return back to your current location if you start the hike now.

Once the return time has been set, an alert will be displayed a little before halfway through the hike to remind you to turn back if you want to return on time. The time until the turn back time is displayed at the top of the screen.

### Return before dark
If you click the "Return before dark" button, the return time will be set to sunset. This is useful if you want to make sure you return before it gets dark.

## Cancel the alert
You can cancel the alert by clicking the "Cancel" button at the bottom of the screen. This will clear the return time and the alert.
3 changes: 2 additions & 1 deletion site/guides.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@ const guides = [
"tool_sensors",
"tool_settings",
"tool_solar_panel_aligner",
"tool_tools",
"tool_temperature_estimation",
"tool_tides",
"tool_tools",
"tool_triangulate_location",
"tool_turn_back",
"tool_water_boil_timer",
"tool_weather",
"tool_whistle",
Expand Down

0 comments on commit ac8c845

Please sign in to comment.