doxa-maps/library/README.md
doxa-maps eb5545da69
Some checks are pending
Deploy to GitHub Pages / build (push) Waiting to run
Deploy to GitHub Pages / deploy (push) Blocked by required conditions
Deep-link preload + library/README (architecture clarity)
- Deep links (#/research-map etc.) now get a modulepreload for their resolved
  bundle at parse time, parallelizing the fetch with the Mapbox peer — the
  static preload only warmed the default landing bundle. Map mirrored from the
  PROFILES registry with cross-referenced maintenance comments.
- library/README.md: the missing top-level orientation for the shared template
  (@map) — folder-by-folder, paired with app-profiles/README and the
  components WARNING.
2026-09-16 02:02:24 +00:00

1.6 KiB

library/ (@map) — the shared map template

The other half of the architecture (see ../app-profiles/README.md): every map in app-profiles/<your-map>/ composes the reusable, parameterized pieces that live here. Fix something here and every map benefits on the next build; break something here and every map breaks — read components/WARNING.md before touching shared pieces.

Folder What lives there
ProfileLoader.vue The root of every bundle: parses profile-config, loads the profile, provides the stores + config
components/ Shared UI — map, legends, controls, popup (PeopleGroupDetail), tables, charts, hints (README)
composables/ Shared logic — map engine (useMapInstance), provider switch, shadow-DOM styles, theming
stores/ Per-instance Pinia stores (ui / map / data) — provided by ProfileLoader, injected by children
api/ Data-source registry (sources.json) + fetch layer — the JAMstack runtime wiring
colors/ Color sets maps opt into via profile-config.colorSet
i18n/ The shared string catalogs (all maps speak the same languages)
data/ Small shared datasets baked at build time (big served data lives in ../data/)
constants/ Shared constants
scripts/ Maintainer pipelines (posters, research) — not part of any bundle

The rule of thumb (same as WARNING.md): custom code in your app-profile, reusable code here — and things only move from the first to the second once they've earned it.