Repository navigation
Bring the docs and wiki up to 0.3.10 - #86
Merged
Merged
Conversation
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).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
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_TAGSvalue (4, not 3) and test count (145) are fixed.Pictures
main.README and HANDOFF
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).