Skip to content

Commit 31f6f29

Browse files
committed
add comprehensive Workbench documentation for Reitti v5.0, including features, usage guidelines, and best practices
1 parent 3448259 commit 31f6f29

5 files changed

Lines changed: 126 additions & 1 deletion

File tree

docs/configurations/map-styles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,4 +114,4 @@ When 3D building layers are found, the 3D buildings toggle becomes available in
114114
- **Start with built-in styles**: Use the default or colored Reitti style before creating custom ones
115115
- **Use Maputnik for JSON styling**: The [Maputnik editor](https://maplibre.org/maputnik/) is the recommended tool for visually designing Style JSON
116116
- **Enable proxy for external tile services**: This reduces load times and respects rate limits
117-
- **Share styles if you manage multiple users**: Create a consistent map experience across your organization
117+
- **Share styles if you manage multiple users**: Create a consistent map experience across your instance

docs/workbench/index.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
title: "Workbench"
3+
description: "Merge, edit, and stitch location data from multiple devices"
4+
weight: 1
5+
tags: ["usage", "workbench", "data-merge"]
6+
---
7+
8+
|since|v5.0.0|.version-badge|
9+
10+
The **Workbench** is Reitti's tool for merging and editing location data from multiple devices. It allows you to combine GPS data from different sources into your personal timeline, giving you full control over which data points are included.
11+
12+
![Workbench Interface](workbench.png)
13+
14+
## Overview
15+
16+
The Workbench consists of two main areas:
17+
18+
- **Map Area** – Displays the path of the selected day ± 24 hours
19+
- **Stitching Area** – A synced area with two timelines for merging data
20+
21+
![Stitching Area](workbench-stitching.png)
22+
23+
### Map Area
24+
25+
The map shows the selected device's path for the chosen day, with a ±24-hour window around it. When you select a timeframe in the stitching area, the corresponding path is highlighted on the map.
26+
27+
### Stitching Area
28+
29+
The stitching area is synced to the map and contains two timelines:
30+
31+
- **Upper Timeline** – Displays data from your **main timeline** (the default device)
32+
- **Lower Timeline** – Displays data from the **selected device**
33+
34+
Both timelines show the same time range, allowing you to compare and merge data.
35+
36+
## Stitching Process
37+
38+
1. **Select a device** – Use the device picker to choose which device's data you want to merge
39+
2. **Select a timeframe** – A slider overlays the device timeline, allowing you to:
40+
- Move the start and end points independently
41+
- Move the entire timeframe selection as a unit
42+
3. **Preview on map** – The selected timeframe is highlighted on the map
43+
4. **Insert** – Press the **Insert** button to add this slice to your main timeline
44+
5. **Save** – All actions are performed locally. Only when you press **Save** are changes persisted to the server
45+
6. **Recalculation** – After saving, all necessary data is recalculated. You can monitor progress under **Settings > Job Status**
46+
47+
## Stitching Area Controls
48+
49+
The lower timeline area includes the following controls:
50+
51+
![Actions Bar](workbench-actions.png)
52+
53+
### Date Picker
54+
55+
A date picker for navigating through the selected device's data.
56+
57+
### Selection Mode
58+
59+
Three modes for interacting with GPS data:
60+
61+
| Key | Mode | Description |
62+
|-----|-------------|----------------------------------------------|
63+
| `1` | **Inspect** | View details of individual GPS points |
64+
| `2` | **Select** | Select individual GPS points for editing |
65+
| `3` | **Box** | Select multiple points using a box selection |
66+
67+
### Help Menu
68+
69+
The help menu provides keyboard shortcuts and tool descriptions.
70+
71+
#### Keyboard Shortcuts
72+
73+
**Selection**
74+
75+
| Shortcut | Action |
76+
|-----------------------------------|------------------------------------------|
77+
| `Ctrl` + `` / `` | Previous / next point |
78+
| `Ctrl` + `Shift` + `` / `` | Extend selection by one point |
79+
| `Ctrl` + `Home` / `End` | Jump to first / last point in the window |
80+
| `Ctrl` + `Shift` + `Home` / `End` | Extend selection to start / end |
81+
| `Ctrl` + `A` | Select all points in the editable window |
82+
| `Esc` | Clear selection |
83+
84+
**Editing**
85+
86+
| Shortcut | Action |
87+
|----------|------------------------|
88+
| `Delete` | Remove selected points |
89+
90+
> **Note:** On macOS, `Cmd` works in place of `Ctrl`.
91+
92+
### Device Picker
93+
94+
Select which device's data you want to work with.
95+
96+
### Delete Button
97+
98+
Removes selected GPS points from the map.
99+
100+
### Moving Points
101+
102+
After selecting a GPS point, you can drag it to a new location on the map. This allows you to correct inaccurate location data.
103+
104+
## Saving and Persistence
105+
106+
All edits are performed **locally** in the browser. Changes are only saved to the server when you:
107+
108+
1. Press the **Save** button
109+
2. Confirm the save action
110+
111+
After saving, the server recalculates your timeline. You can monitor the progress under **Settings > Job Status**.
112+
113+
## Use Cases
114+
115+
- **Correcting GPS drift** – Move inaccurate points to their correct location
116+
- **Merging multiple devices** – Combine data from a phone and a car tracker into one timeline
117+
- **Removing unwanted data** – Delete specific GPS points that should not appear in your timeline
118+
- **Stitching time slices** – Select a timeframe from one device and insert it into your main timeline
119+
120+
## Best Practices
121+
122+
- **Use the preview** – Always check the map before inserting data
123+
- **Save frequently** – Save your changes regularly to avoid losing work
124+
- **Monitor job status** – Check **Settings > Job Status** to see when recalculations are complete
125+
- **Start with small selections** – Begin with a small timeframe to verify the merge works correctly
69.4 KB
Loading
224 KB
Loading

docs/workbench/workbench.png

1.09 MB
Loading

0 commit comments

Comments
 (0)