78fa7ac10a
how-to's provider note said MapLibre was 'shipping on a branch / preview' — it is on main with token-free generated pages and a living demo instance, guarded by the embed smoke. reference.md: provider line updated (token-free, no tk needed under maplibre) and the geocoder search-bar opt-in is now documented (simple-map ships search OFF by design; research-map keeps it). |
||
|---|---|---|
| .. | ||
| architecture | ||
| assets | ||
| explanation.md | ||
| how-to.md | ||
| README-embed-example.md | ||
| README.md | ||
| reference.md | ||
| slide-deck-outline.md | ||
| tutorial.md | ||
| why.md | ||
docs/ — pick your path
"what is this?" "teach me" "how do I …?" "look it up" "all the detail"
│ │ │ │ │
why.md ──────────► tutorial.md ────► how-to.md ────► reference.md ───► architecture/
(2 min, 1 diagram) (first map) (task recipes) (tables) (contracts)
- why.md — the problem and the "map islands" idea. Start here.
- tutorial.md — build your first map, no jargon.
- how-to.md — recipes: embed, iframe, SPA, colors, CDN, mobile, tokens.
- reference.md — config fields, build scripts, the
profile-configcontract. - explanation.md — the model in 15 lines.
- architecture/ — the deep end: full contracts, the per-file catalog.
- README-embed-example.md — the drop-in README used when this bundler is embedded inside a host repo.
Nothing on the simple path is longer than a few minutes; everything complex lives in
architecture/, linked from where you'd need it.