History

doxa-maps 692b25e1f5 Some checks are pending Deploy to GitHub Pages / build (push) Waiting to run Details Deploy to GitHub Pages / deploy (push) Blocked by required conditions Details docs: slide-deck outline (BLUF hand-off pitch) from the handoff distillate		2026-09-11 22:05:23 +00:00
..
architecture	docs: skimmer pass — README to 1 diagram + 2 tables; how-to task index; docs/ router; CONTRIBUTING 384→61 (patterns+history → architecture)	2026-09-11 18:50:31 +00:00
explanation.md	docs: add why.md — problem-first 'map islands' concept page (Vite/Astro/Stencil pattern); wire into front doors + playground link	2026-09-11 18:50:31 +00:00
how-to.md	docs: close retest gaps — engine-swap recipe (provider param), instances.json recipe + schema, adopt embed-example into router	2026-09-11 18:50:31 +00:00
README-embed-example.md	docs: simple README template for the embedded (in-host) copy	2026-09-11 18:50:31 +00:00
README.md	docs: close retest gaps — engine-swap recipe (provider param), instances.json recipe + schema, adopt embed-example into router	2026-09-11 18:50:31 +00:00
reference.md	docs: close retest gaps — engine-swap recipe (provider param), instances.json recipe + schema, adopt embed-example into router	2026-09-11 18:50:31 +00:00
slide-deck-outline.md	docs: slide-deck outline (BLUF hand-off pitch) from the handoff distillate	2026-09-11 22:05:23 +00:00
tutorial.md	docs: fix cold-read gaps — embeddability design doc (generated pages + manifest), SPA recipe + PROFILES contract, copy-rename checklist	2026-09-11 18:50:31 +00:00
why.md	docs: decoupled-twin pairing section in why.md; composable/embeddable-first terms in one-liner; experimental-vs-production profile convention	2026-09-11 19:24:27 +00:00

README.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-config contract.
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.