doxa-life/doxa-maps
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
doxa-maps/docs
History
doxa-maps-88655c70 688f16c828 add Step 3b to the golden path: prove the plugin mounts before publishing 
The golden path took an author from author -> build -> PUBLISH TO THE LIVE
CATALOG without ever opening the element in a browser. Every guard in Step 3 is
static: it checks that files exist, parse, carry a correct SRI hash and resolve.
None of them renders anything.

Proved the gap rather than asserting it: injecting a throw into a component's
setup() produced a SUCCESSFUL build (206 kB emitted, exit 0) with check:parse
PASS and check:drop PASS, while smoke:embeds reported 0/2 pages mounting. After
restoring, the same command reports 2/2.

The step documents the token requirement because its absence is loud and
misleading: without it every map profile fails to mount (27/40) and reads like
13 broken plugins. It also records why this is not a CI step - CI is the single
authoritative builder but installs no browser binary.

All three quoted commands were run as written before being documented.
2026-09-21 20:45:36 +00:00
..
architecture point docs at library/layouts and fix the stale bunx and provider-ladder claims 2026-09-21 10:43:11 +00:00
assets README: lead with the SPA-composition trinity + visual proof (desktop & mobile) 2026-09-16 00:17:45 +00:00
readme-images light the remaining unconditional loading overlays and the copy-me starter 2026-09-21 16:40:53 +00:00
screenshots README: distinguish the two cap-5 apps (product SPA vs developer studio) and add current capability screenshots 2026-09-20 05:00:01 +00:00
develop-a-plugin-and-see-it-live.md add Step 3b to the golden path: prove the plugin mounts before publishing 2026-09-21 20:45:36 +00:00
explanation.md Complete app-profiles->plugin-designs sweep across comments/docs; build green; layouts kept at root (load-bearing) 2026-09-17 18:18:19 +00:00
how-to.md point docs at library/layouts and fix the stale bunx and provider-ladder claims 2026-09-21 10:43:11 +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-longform.md point docs at library/layouts and fix the stale bunx and provider-ladder claims 2026-09-21 10:43:11 +00:00
README-SECTION-3-cli-commands.md say what cap sync actually stages instead of a bundle count that matches nothing 2026-09-21 16:45:39 +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-capability-exemplars.md generate the capability exemplar table so the answer stops being remembered 2026-09-21 12:38:50 +00:00
reference-library-index.md generate the library menu and gate it against library drift 2026-09-21 07:25:18 +00:00
reference.md prove the live server serves the catalog's exact bytes 2026-09-21 12:46:48 +00:00
slide-deck-outline.md Plugin gallery: one generator for the dev server and the build 2026-09-16 20:04:18 -05:00
tutorial.md point the tutorial at the studio folder and separate build from publish 2026-09-21 07:38:50 +00:00
why.md README: lead with the story — one sign-up site is the bottleneck, the map embeds on every partner team's site, Training-for-Trainers roles, the share-button campaign, private CRM for the team list 2026-09-16 12:34:59 -05: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.