Skip to content

Commit 5203fd8

Browse files
committed
Refine onboarding entrypoint and clarify visibility guidance
1 parent d0ff162 commit 5203fd8

7 files changed

Lines changed: 438 additions & 32 deletions

File tree

docs/onboarding.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,52 @@
11
# LinkSim Onboarding
22

3-
## 1. Scenarios
4-
- A **simulation** is your working setup: selected sites, links, and radio/model settings.
3+
## Scenarios
4+
- A **simulation** is a complete setup of sites, links, and radio/model settings.
55
- Open an existing simulation from **Simulation Library** or create a new one.
66
- Use clear names so teammates can find simulations quickly.
77

8-
## 2. Sites
8+
## Sites
99
- Sites are physical node locations with coordinates, ground elevation, and antenna height.
1010
- Manage your reusable site collection in **Site Library**.
11-
- Add sites by coordinates, map pick, search, or Meshtastic sources.
11+
- Add sites by coordinates, map pick, search, or Meshtastic MQTT sources.
1212
- Add sites from the library into the current simulation as needed.
13+
- Both sites and simulations can be shared with other users.
1314

14-
## 3. Links
15+
## Links
1516
- A link is a **From -> To** path between two sites used for path analysis.
1617
- Links let you compare multiple candidate paths in one simulation.
1718
- Start with the two sites you care about most, then add relay candidate links.
1819

19-
## 4. Other Settings
20+
## Other Settings
2021
- **Channel**: frequency, bandwidth, SF, coding rate, TX power, gains, cable loss.
2122
- **Propagation model**: FSPL, TwoRay, or ITM (terrain-aware approximation).
2223
- **Terrain**: fetch and refresh terrain before relying on pass/fail decisions.
2324
- **RX target**: your decision threshold; pass/fail is based on this target.
2425

25-
## 5. Map and Plots
26-
- The map shows channel/coverage overlays for the selected simulation and link.
27-
- Use map controls to fit, inspect terrain, and switch visualization modes.
28-
- The **path profile** shows terrain, LOS/Fresnel context, and endpoint relationship.
29-
- Use overlays to find potential relay positions and validate route quality.
26+
## Map and Plots
27+
- The map can display several plot/overlay modes. Use them for different questions:
3028

31-
## 6. User Rights and Permissions
29+
| Plot / Overlay | What it shows | What to use it for |
30+
| --- | --- | --- |
31+
| Heatmap | Continuous RX strength estimate (dBm) across sampled area | Quick quality overview and hotspot discovery |
32+
| Bands (Contours) | Stepped strength zones (same RX model as heatmap, grouped levels) | Fast threshold-oriented planning and area segmentation |
33+
| Pass/Fail | Binary result against current RX target | Clear go/no-go checks for deployment decisions |
34+
| Relay | Best relay-candidate regions for selected From/To pair | Find where a third node could bridge weak links |
35+
| Terrain overlay | Terrain raster used by simulation in current area | Confirm what elevation input the model is actually using |
36+
| Path profile | Elevation profile + link geometry between selected endpoints | Validate LOS/Fresnel context and understand obstructions |
37+
38+
- Practical workflow:
39+
1. Start with **Pass/Fail** for decision clarity.
40+
2. Switch to **Heatmap/Bands** for quality gradients.
41+
3. Use **Relay** to locate candidate repeater sites.
42+
4. Confirm terrain and inspect **Path profile** before finalizing.
43+
44+
## User Rights and Permissions
3245
- User roles: **Pending**, **User**, **Moderator**, **Admin**.
33-
- Resource visibility: **Private**, **Public**, **Shared**.
46+
- Resource visibility:
47+
- **Private**: only owner/admin can view and edit.
48+
- **Public**: everyone can view; owner/moderator/admin can edit.
49+
- **Shared**: everyone can view and edit; only owner/moderator/admin can delete.
3450
- Collaborators grant edit rights on a site or simulation.
3551
- Moderation/admin actions are audited; use least privilege where possible.
3652

0 commit comments

Comments
 (0)