docs: decoupled-twin pairing section in why.md; composable/embeddable-first terms in one-liner; experimental-vs-production profile convention
This commit is contained in:
parent
756bb32c9f
commit
0f38a5448c
3 changed files with 24 additions and 1 deletions
|
|
@ -1,6 +1,6 @@
|
|||
# doxa-maps
|
||||
|
||||
**A bundler that turns your maps into embeddable pieces you can drop onto any website.**
|
||||
**A JAMstack bundler for composable, embeddable-first maps — one build outputs every map as a framework-agnostic web component, and composes them into a single-page application.**
|
||||
|
||||
```
|
||||
app-profiles/<map>/ bun run build where they run
|
||||
|
|
|
|||
|
|
@ -26,6 +26,19 @@ template's building blocks. Your folder is yours (colors, API, i18n); the templa
|
|||
components** (in `src/`). Nothing here leaks to another map.
|
||||
- **Many maps per bundle.** The bundler bundles one map or many — add another flat `.vue` and rebuild.
|
||||
|
||||
## Production or experimental — every profile declares itself
|
||||
|
||||
Every app profile is one of two things, and **experimental profiles are unlimited and
|
||||
encouraged** — create as many as you need:
|
||||
|
||||
- **Experimental, not built:** prefix the folder with `_` — the build skips it; it just sits
|
||||
in code. Zero cost, zero risk.
|
||||
- **Experimental, built:** builds normally, but it belongs in the **Experimental section** of
|
||||
the power app's layout (nav section) — never embedded on partner surfaces.
|
||||
- **Production:** a real product — main sections of the power app + individually embeddable.
|
||||
|
||||
(The **power app** = the SPA layout that composes all profiles into one application.)
|
||||
|
||||
## The pattern in one picture
|
||||
|
||||
```
|
||||
|
|
|
|||
10
docs/why.md
10
docs/why.md
|
|
@ -58,6 +58,16 @@ The same islands compose three ways — this is why there's one bundler, not thr
|
|||
2. **A SPA** — several islands in one lazy-loaded layout = a full map site.
|
||||
3. **A mobile app** — Capacitor wraps the same built folder into Android/iOS.
|
||||
|
||||
## Where this architecture thrives
|
||||
|
||||
The bundler is complete on its own — but it was built to thrive inside an **internal developer
|
||||
platform**: one that detects the built bundles as plugins, onboards multiple users
|
||||
(multi-tenant), gives them MCP/agent access to prototype new maps rapidly *without rebuilding
|
||||
the platform*, funnels feedback, and runs the builds in CI/CD. The bundler ships with none of
|
||||
that — it just supports all of it. Pair it with such a platform and the multiplication
|
||||
compounds: one build multiplies maps; a platform that exports whole configured tenants
|
||||
multiplies deployments; together they multiply each other.
|
||||
|
||||
## Prior art, honestly
|
||||
|
||||
None of the pieces are ours: web components are a browser standard, JAMstack is a movement,
|
||||
|
|
|
|||
Loading…
Reference in a new issue