Skip to content

Bring the docs and wiki up to 0.3.10 - #86

Merged
pepperstm merged 2 commits into
mainfrom
docs/0.3.10
Nov 12, 2026
Merged

pepperstm merged 2 commits into
mainfrom
docs/0.3.10

Conversation

@pepperstm

@pepperstm pepperstm commented Nov 12, 2026 •

Copy link
Copy Markdown
Owner

What and why

The docs hadn't caught up with 0.3.10, and the wiki read more like a developer log than a manual. The wiki is now the user's manual, and how the app is built has a home of its own in the repository.

Wiki, rewritten as a user's manual

  • Routes and the map: how to import, plan and pick routes (your Strava routes, signposted road routes, MTB routes, famous climbs, Dreeve rides), Herne Hill, and what the world is built from, without the OpenStreetMap tags and bend radii.
  • Riding: setting up a ride, the screen and keys, laps, racing, and ending a ride, including that rides under a minute aren't saved. The road-surface figures are cut to a plain example.
  • Connecting your trainer: devices are now remembered. It used to say they weren't. The protocol table is now plain English, with a Linux tip for the connect fix.
  • Strava: routes and private routes added, and the "not yet tried against the live service" note removed, since upload, connecting and routes all work. Disconnect is described correctly: it keeps your key.
  • Virtual gears: the formulas are replaced by a plain explanation. Your first ride, Home, FAQ, Installing and Group rides are updated to match, and the relay is downloaded rather than built with cargo. Developer pages are grouped under "For developers".

Developer pages: docs/developers/
A full breakdown of how the app is built, a chapter for each part, written from the code: architecture (the layers, a map of every module, how a ride flows), building and testing (the smoke harness, CI), routes, physics and trainer control (including virtual gears), the ride (engine, laps, ghosts, segments, recording, XP, fitness, workouts), the 3D world (terrain, map matching, surfaces, trails, berms, fords, bridges, buildings, trees, fields, barriers, the velodrome), drawing (three.js and the native renderer), devices (Bluetooth, ANT+, the hub, controllers), connectors and services, data and diagnostics, and releasing. Start at docs/developers/README.md.

The wiki's Architecture and Building from source pages become short pointers to these, so old links still work, and README, CONTRIBUTING and HANDOFF link to them. HANDOFF's WAY_TAGS value (4, not 3) and test count (145) are fixed.

Pictures

  • New screenshots of Routes (Herne Hill in the library), Find a route (the Strava, road and MTB sections) and Devices (the remembered-sensor notice), taken with the smoke harness on main.
  • The 0.3.10 ride pictures from the website: dusk in the rain, hairpins, workout, and Herne Hill (new).
  • A new README hero, made from the 0.3.10 Alpe d'Huez clip (same 4 s at 10 fps; 1.9 MB).

README and HANDOFF

  • Find a route covers road routes, Strava routes and Dreeve imports.
  • The status table is honest about what has been tried live (Strava, Dreeve, a Linux rider) and what hasn't (remembered sensors with real hardware, the Linux fix, Strava segments and ghost imports).

Checks

Docs and images only. Every app label quoted was checked against web/src/ui. In the developer pages, every code name was checked to exist in the source, every relative link and section anchor resolves, and the numbers were read from the constants (the 200 W speeds were worked out from the physics formula).

The wiki now reads as a user's manual: plain instructions, the developer
detail left to the README and HANDOFF. New screenshots of Routes, Find a route
and Devices, the 0.3.10 ride pictures and a new hero clip.
docs/developers/ holds a chapter for each part of the app: architecture,
building and testing, routes, physics and trainer control, the ride, the
3D world, drawing, devices, connectors and services, data and diagnostics,
and releasing. The wiki stays a user's manual; its Architecture and
Building from source pages now point here.

Also fixes HANDOFF's WAY_TAGS value (4, not 3) and its test count (145).
@pepperstm
pepperstm merged commit 4d474c5 into main Nov 12, 2026
6 checks passed
@pepperstm
pepperstm deleted the docs/0.3.10 branch November 12, 2026 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant