Skip to content

docs: add complete project and crate run guides - #23

Merged
404khai merged 1 commit into
mainfrom
docs/project-and-crate-readmes
Oct 7, 2026
Merged

404khai merged 1 commit into
mainfrom
docs/project-and-crate-readmes

Conversation

@404khai

@404khai 404khai commented Oct 7, 2026

Copy link
Copy Markdown
Owner

Roadrunner had no root or crate READMEs, leaving setup and executable workflows scattered across phase documentation. Add a project guide and a README for each of the five crates, with commands grounded in the merged Phase 17 implementation.

The guides cover toolchain setup, all current CLI commands, OSM extraction/compilation/verification, static and time-dependent traffic, single-order and pooled simulation, dispatch comparison and examples, tests, API docs, all six Criterion targets, replay and benchmark collectors. Crate guides describe public interfaces and module boundaries. Examples specify repository-root invocation, source OSM endpoints, exact source identities required by traffic fixtures, and fresh snapshot output directories.

Document optional Docker/Python OSM prerequisites, versioned scenario semantics, and deferred functionality. Explain that the historical Phase 7 assembler embeds old metadata and align the rider collector's compiler metadata with its benchmark toolchain. This PR changes documentation only; Phase 18 remains deferred.

Validation:

  • Verified all 72 relative README links and heading anchors.
  • Executed documented root and crate OSM/routing workflows, static/time-dependent traffic, simulation and dispatch comparison commands, plus both dispatch examples.
  • Passed all six Criterion targets in smoke mode; these checks are not new statistical benchmark measurements.
  • Ran all three simulation/strategy/pooling collectors with two measured runs each; replay and all 11 pooled fixtures passed their collector checks.
  • Passed API documentation generation and three Python reference-comparison unit tests.
  • Passed cargo fmt --all -- --check, strict workspace Clippy, and all 159 workspace tests with Rust 1.99.0 for Clippy/tests.
  • Optional Docker/OSRM integration and Python osmium fixture generation were not executed; their command signatures and prerequisites were checked.

@404khai
404khai merged commit 93b22d2 into main Oct 7, 2026
4 checks passed
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