Skip to content

Commit d6ab225

Browse files
uw-amy-bordenaveuw-amy-bordenave
authored
Merge pull request #31 from TaskarCenterAtUW/feat/docs-asr/2494-update-user-manual
Update AVIV ScoutRoute User Manual
2 parents 5264c32 + f705146 commit d6ab225

File tree

66 files changed

+34979
-256
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+34979
-256
lines changed

‎docs/aviv-scoutroute/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ _For a list of all guides on the TCAT Wiki, refer to the [Guides List](../guides
1818

1919
#### [AVIV ScoutRoute User Manual](user-manual/index.md)
2020

21-
This user manual explains how to install and use the AVIV ScoutRoute mobile app.
21+
This guide serves as a user manual and documentation reference for the AVIV ScoutRoute mobile app.
2222

2323
#### [Long Form Quest Definition](quests/index.md) Guides
2424

‎docs/aviv-scoutroute/user-manual/app-settings.md‎

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
---
2+
title: App Settings
3+
tags:
4+
- Guide
5+
- External
6+
- User
7+
# exclude-from-main-guides-list
8+
---
9+
10+
<!-- @format -->
11+
12+
## App Settings
13+
14+
This guide provides a complete reference for all settings, controls, and features available in AVIV ScoutRoute.
15+
16+
_For a list of all guides on the TCAT Wiki, refer to the [Guides List](../../guides-list/index.md)._
17+
18+
---
19+
20+
### My Profile
21+
22+
The My Profile section displays your account information and authentication settings.
23+
24+
To access, select the **My Profile** button on the left of the top bar.
25+
26+
**Available actions:**
27+
28+
- **Enable/disable biometric login:** Toggle on-device fingerprint / facial recognition option for faster sign-in
29+
- **Logout:** Sign out of your TDEI account
30+
31+
<!-- === "Android" -->
32+
33+
<!-- IMAGE PLACEHOLDER: User profile screen | ../../resources/images/aviv-scoutroute/android/user-profile-dark.png#only-dark{ width="300" } -->
34+
<!-- IMAGE PLACEHOLDER: User profile screen | ../../resources/images/aviv-scoutroute/android/user-profile-light.png#only-light{ width="300" } -->
35+
36+
<!-- === "iOS (Apple)" -->
37+
38+
<!-- IMAGE PLACEHOLDER: User profile screen | ../../resources/images/aviv-scoutroute/ios/user-profile-dark.png#only-dark{ width="300" } -->
39+
<!-- IMAGE PLACEHOLDER: User profile screen | ../../resources/images/aviv-scoutroute/ios/user-profile-light.png#only-light{ width="300" } -->
40+
41+
---
42+
43+
### Menu
44+
45+
The menu (three stacked horizontal bars) provides quick access to key features from the main map view.
46+
47+
<!-- === "Android" -->
48+
49+
<!-- IMAGE PLACEHOLDER: Hamburger menu open | ../../resources/images/aviv-scoutroute/android/hamburger-menu-dark.png#only-dark{ width="300" } -->
50+
<!-- IMAGE PLACEHOLDER: Hamburger menu open | ../../resources/images/aviv-scoutroute/android/hamburger-menu-light.png#only-light{ width="300" } -->
51+
52+
<!-- === "iOS (Apple)" -->
53+
54+
<!-- IMAGE PLACEHOLDER: Hamburger menu open | ../../resources/images/aviv-scoutroute/ios/hamburger-menu-dark.png#only-dark{ width="300" } -->
55+
<!-- IMAGE PLACEHOLDER: Hamburger menu open | ../../resources/images/aviv-scoutroute/ios/hamburger-menu-light.png#only-light{ width="300" } -->
56+
57+
**Menu options:**
58+
59+
| Option | Description |
60+
|:-----------------------|:---------------------------------------|
61+
| **Close** (++x++) | Close the hamburger menu |
62+
| **Settings** (gear) | Open the Settings menu |
63+
| **Download data here** | Download map data for the current area |
64+
| **Switch workspace** | Return to the workspace selection list |
65+
66+
---
67+
68+
### Download Data
69+
70+
The Download Data feature lets you pre-load map data for the visible area, which can be especially useful when you'll be mapping in areas with poor cellular connectivity.
71+
72+
**How to access:** Open the hamburger menu and tap **Download data here**.
73+
74+
<!-- === "Android" -->
75+
76+
<!-- IMAGE PLACEHOLDER: Download data screen | ../../resources/images/aviv-scoutroute/android/download-data-dark.png#only-dark{ width="300" } -->
77+
<!-- IMAGE PLACEHOLDER: Download data screen | ../../resources/images/aviv-scoutroute/android/download-data-light.png#only-light{ width="300" } -->
78+
79+
<!-- === "iOS (Apple)" -->
80+
81+
<!-- IMAGE PLACEHOLDER: Download data screen | ../../resources/images/aviv-scoutroute/ios/download-data-dark.png#only-dark{ width="300" } -->
82+
<!-- IMAGE PLACEHOLDER: Download data screen | ../../resources/images/aviv-scoutroute/ios/download-data-light.png#only-light{ width="300" } -->
83+
84+
**How to download:**
85+
86+
1. Navigate the map to the area you want to download
87+
2. Open the hamburger menu and select **Download data here**
88+
89+
---
90+
91+
### Switch Workspace
92+
93+
The Switch Workspace option returns you to the workspace selection screen, allowing you to change to a different project without logging out.
94+
95+
**How to access:** Open the hamburger menu and tap **Switch workspace**.
96+
97+
<!-- === "Android" -->
98+
99+
<!-- IMAGE PLACEHOLDER: Switch workspace flow | ../../resources/images/aviv-scoutroute/android/switch-workspace-dark.png#only-dark{ width="300" } -->
100+
<!-- IMAGE PLACEHOLDER: Switch workspace flow | ../../resources/images/aviv-scoutroute/android/switch-workspace-light.png#only-light{ width="300" } -->
101+
102+
<!-- === "iOS (Apple)" -->
103+
104+
<!-- IMAGE PLACEHOLDER: Switch workspace flow | ../../resources/images/aviv-scoutroute/ios/switch-workspace-dark.png#only-dark{ width="300" } -->
105+
<!-- IMAGE PLACEHOLDER: Switch workspace flow | ../../resources/images/aviv-scoutroute/ios/switch-workspace-light.png#only-light{ width="300" } -->
106+
107+
**How to switch:**
108+
109+
1. Open the hamburger menu and select **Switch workspace**
110+
2. The workspace list appears showing all available workspaces
111+
3. Tap the workspace you want to contribute to
112+
4. The app loads the new workspace
113+
114+
**Use cases:**
115+
116+
- Moving between different project areas
117+
- Working on multiple mapping initiatives
118+
119+
For more details on workspaces, see [Getting Started - Selecting a Workspace](getting-started.md#selecting-a-workspace).
120+
121+
---
122+
123+
### Settings Menu
124+
125+
In the menu, select the **Settings (gear icon)** to open the Settings menu.
126+
127+
<!-- === "Android" -->
128+
129+
<!-- IMAGE PLACEHOLDER: Settings menu open | ../../resources/images/aviv-scoutroute/android/settings-menu-dark.png#only-dark{ width="300" } -->
130+
<!-- IMAGE PLACEHOLDER: Settings menu open | ../../resources/images/aviv-scoutroute/android/settings-menu-light.png#only-light{ width="300" } -->
131+
132+
<!-- === "iOS (Apple)" -->
133+
134+
<!-- IMAGE PLACEHOLDER: Settings menu open | ../../resources/images/aviv-scoutroute/ios/settings-menu-dark.png#only-dark{ width="300" } -->
135+
<!-- IMAGE PLACEHOLDER: Settings menu open | ../../resources/images/aviv-scoutroute/ios/settings-menu-light.png#only-light{ width="300" } -->
136+
137+
The Settings menu is organized into categories:
138+
139+
| Category | Description |
140+
|:------------------|:----------------------------------------------|
141+
| **Quests** | Quest selection and display order |
142+
| **Communication** | Data upload and sync settings |
143+
| **Display** | Theme, map controls, and screen behavior |
144+
| **Advanced** | Cache management and hidden quest restoration |
145+
| **Debug** | Debugging and diagnostic tools |
146+
147+
---
148+
149+
### Quests Settings
150+
151+
#### Quest Selection and Display Order
152+
153+
Control which quest types appear on the map and their priority order.
154+
155+
<!-- === "Android" -->
156+
157+
<!-- IMAGE PLACEHOLDER: Quest selection screen | ../../resources/images/aviv-scoutroute/android/quest-selection-dark.png#only-dark{ width="300" } -->
158+
<!-- IMAGE PLACEHOLDER: Quest selection screen | ../../resources/images/aviv-scoutroute/android/quest-selection-light.png#only-light{ width="300" } -->
159+
160+
<!-- === "iOS (Apple)" -->
161+
162+
<!-- IMAGE PLACEHOLDER: Quest selection screen | ../../resources/images/aviv-scoutroute/ios/quest-selection-dark.png#only-dark{ width="300" } -->
163+
<!-- IMAGE PLACEHOLDER: Quest selection screen | ../../resources/images/aviv-scoutroute/ios/quest-selection-light.png#only-light{ width="300" } -->
164+
165+
**How to use:**
166+
167+
1. Tap **Quest selection and display order** to open the submenu
168+
2. Toggle each quest type **on** or **off**
169+
3. Hold and drag quest types to reorder their display priority
170+
4. Only enabled quest types will show on the map
171+
172+
!!! tip
173+
174+
If you want to focus on one type of feature during a mapping session (e.g., only sidewalks), disable the other quest types temporarily.
175+
176+
---
177+
178+
### Communication Settings
179+
180+
#### Upload Answers Automatically
181+
182+
Toggle automatic upload of completed quest answers.
183+
184+
| Setting | Description |
185+
|:---------------------------------|:------------------------------------------------------------------------------------------------------------|
186+
| **Upload answers automatically** | When enabled, quest answers sync immediately; when disabled, answers are stored locally until manual upload |
187+
188+
---
189+
190+
### Display Settings
191+
192+
Configure the visual appearance and behavior of the app.
193+
194+
| Setting | Description |
195+
|:--------------------------|:--------------------------------------------------------|
196+
| **Theme** | Choose between light, dark, or follow-system theme |
197+
| **Show map zoom buttons** | Toggle on-screen zoom controls (+/−) on the map |
198+
| **Keep screen on** | Prevent the screen from dimming during mapping sessions |
199+
200+
---
201+
202+
### Advanced Settings
203+
204+
Access cache management and options for hidden quests.
205+
206+
| Setting | Description |
207+
|:--------------------------|:----------------------------------------------------|
208+
| **Delete cache** | Clear locally cached map data to free storage space |
209+
| **Restore hidden quests** | Unhide all previously hidden quests at once |
210+
211+
---
212+
213+
### Debug Settings
214+
215+
Diagnostic tools for testing and troubleshooting.
216+
217+
#### Show Quest Forms
218+
219+
Preview quest definition forms without affecting real data.
220+
221+
<!-- === "Android" -->
222+
223+
<!-- IMAGE PLACEHOLDER: Show quest forms screen | ../../resources/images/aviv-scoutroute/android/show-quest-forms-dark.png#only-dark{ width="300" } -->
224+
<!-- IMAGE PLACEHOLDER: Show quest forms screen | ../../resources/images/aviv-scoutroute/android/show-quest-forms-light.png#only-light{ width="300" } -->
225+
226+
<!-- === "iOS (Apple)" -->
227+
228+
<!-- IMAGE PLACEHOLDER: Show quest forms screen | ../../resources/images/aviv-scoutroute/ios/show-quest-forms-dark.png#only-dark{ width="300" } -->
229+
<!-- IMAGE PLACEHOLDER: Show quest forms screen | ../../resources/images/aviv-scoutroute/ios/show-quest-forms-light.png#only-light{ width="300" } -->
230+
231+
**How to use:**
232+
233+
1. Tap **Show quest forms** to open the quest type selection menu
234+
2. Select a quest type to view its example form
235+
3. Fill out the form to see how answers are structured
236+
4. Submit to view the actual tag changes that would result from those answers
237+
238+
!!! info
239+
240+
This feature is useful for understanding how quest answers translate to map data tags, or for testing quest definitions during development.
241+
242+
---
243+
244+
### Next Steps
245+
246+
- Review [Completing Quests](completing-quests.md) for the main workflow
247+
- See [Undo Changes](map-interface.md#undo-changes) if you need to correct a submission

0 commit comments

Comments
 (0)