Skip to content

Commit d0ff162

Browse files
committed
Add first-login onboarding modal with markdown guide
1 parent eeefd31 commit d0ff162

7 files changed

Lines changed: 1373 additions & 63 deletions

File tree

docs/onboarding.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# LinkSim Onboarding
2+
3+
## 1. Scenarios
4+
- A **simulation** is your working setup: selected sites, links, and radio/model settings.
5+
- Open an existing simulation from **Simulation Library** or create a new one.
6+
- Use clear names so teammates can find simulations quickly.
7+
8+
## 2. Sites
9+
- Sites are physical node locations with coordinates, ground elevation, and antenna height.
10+
- Manage your reusable site collection in **Site Library**.
11+
- Add sites by coordinates, map pick, search, or Meshtastic sources.
12+
- Add sites from the library into the current simulation as needed.
13+
14+
## 3. Links
15+
- A link is a **From -> To** path between two sites used for path analysis.
16+
- Links let you compare multiple candidate paths in one simulation.
17+
- Start with the two sites you care about most, then add relay candidate links.
18+
19+
## 4. Other Settings
20+
- **Channel**: frequency, bandwidth, SF, coding rate, TX power, gains, cable loss.
21+
- **Propagation model**: FSPL, TwoRay, or ITM (terrain-aware approximation).
22+
- **Terrain**: fetch and refresh terrain before relying on pass/fail decisions.
23+
- **RX target**: your decision threshold; pass/fail is based on this target.
24+
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.
30+
31+
## 6. User Rights and Permissions
32+
- User roles: **Pending**, **User**, **Moderator**, **Admin**.
33+
- Resource visibility: **Private**, **Public**, **Shared**.
34+
- Collaborators grant edit rights on a site or simulation.
35+
- Moderation/admin actions are audited; use least privilege where possible.
36+
37+
## Recommended Workflow
38+
1. Open or create a simulation.
39+
2. Add sites from Site Library.
40+
3. Create links for the paths you want to evaluate.
41+
4. Auto-fetch terrain data.
42+
5. Set channel + model, then inspect map + path profile.
43+
6. Save the simulation and share/collaborate as needed.

0 commit comments

Comments
 (0)