Repository navigation
Conversation
…ift-gate)
Build the visual assets from the library's own output, mirroring the
filecast ".tape next to the .gif" pattern: all geo-math stays in C++
(tools/assets/emit.cpp runs the real decode -> bounds -> simplify -> snap ->
point_at_distance -> encode pipeline over the same 95-point track as
examples/gps_track.cpp and emits GeoJSON/JSONL); the Python renderers only
draw the committed data.
Deterministic stages (byte-stable, CI drift-gated):
- tools/render/bench.py -> docs/assets/benchmarks.svg
- tools/render/hero.py -> docs/assets/hero-pipeline.gif + gallery/simplify.gif
- tools/render/social.py -> docs/assets/social-preview.png
- tools/assets/emit.cpp -> docs/assets/data/{track.geojson,dp.jsonl,eta.jsonl}
Manual stages (committed by hand, not gated):
- docs/assets/demo.tape -> docs/assets/demo.gif (VHS terminal capture)
- tools/render/gallery.py -> docs/assets/gallery/*.png (OSM/cartopy tiles)
Orchestration + gate:
- tools/make-assets.sh one entry point (emitter + renders)
- tools/render/requirements.txt pinned deps (matplotlib bundles FreeType 2.6.1)
- .github/workflows/assets.yml rebuilds the emitter and regenerates only the
deterministic assets, then git diff --exit-code
No library API changes; renderers are tooling only. README wiring is left to
the README briefs. gallery/*.png are deferred (need tile-server network +
staticmap/cartopy, unavailable in this sandbox).
gistrec
marked this pull request as draft
July 7, 2026 00:16
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.
Adds the reproducible pipeline that generates the README imagery from the
library's own output — all the geo-math runs in C++ (
tools/assets/emit.cpp,reusing the
examples/gps_track.cpppipeline); the Python renderers only draw.What's in it
tools/assets/emit.cpp— C++17 GeoJSON/JSONL emitter that reuses the exactdecode → bounds → simplify → closest_point_on_path → point_at_distance → encodepipeline, so every picture is drawn from real library output (single source of
truth for the geometry).
tools/render/{bench,hero,social,gallery}.py+tools/make-assets.sh.docs/assets/benchmarks.svg,hero-pipeline.gif,social-preview.png,gallery/simplify.gif(the Douglas-Peucker collapseanimated over real Tampa map tiles), and the emitter data under
docs/assets/data/.Reproducibility & CI
Renders are deterministic by construction: pinned
matplotlib/pillow/numpy(+ transitive deps that touch the bytes) in
tools/render/requirements.txt, andthe nondeterminism knobs are disabled — fixed
svg.hashsalt,svg.fonttype=path(glyphs embedded as outlines, so output doesn't depend on installed fonts), no
Datemetadata in the SVG, and a pinnedSoftwaretag in the PNG..github/workflows/assets.ymlrebuilds the emitter (-Werror) and re-rendersevery asset on
macos-latest/ Python 3.13 as a smoke test (they must buildand render without error), then byte-gates only
benchmarks.svg— the onegenuinely platform-independent artifact (uncompressed text, glyph outlines via
pinned
fonttools, no zlib/LZW amplification). The rasters and GIFs(
hero-pipeline.gif,gallery/simplify.gif,social-preview.png) are notbyte-diffed: byte-exact matplotlib Agg raster reproduction across independently
provisioned runners is unreliable, so — like the four gallery tile stills — they
are committed by hand. Regenerate everything locally with
bash tools/make-assets.sh.Deferred (not in this PR)
The four operations-gallery stills (
great-circle/snap-to-route/point-in-polygon/encode-decode.png, #5–#8) also fetch map tiles(
staticmap/cartopy+ network) and are committed by hand;gallery.pyrenders them (
bash tools/make-assets.sh --all) and they land in a follow-upcommit. (The animated
gallery/simplify.gifabove is already rendered andincluded.)