From c46a9a04bd433f997ffa46645658ebfb8d24ea9a Mon Sep 17 00:00:00 2001 From: doxa-maps-88655c70 <88627970+doxa-maps-88655c70@users.noreply.github.com> Date: Thu, 24 Sep 2026 18:34:02 +0000 Subject: [PATCH] README: lead with the objectives, showcase the Research Gallery, teach the agent swarm - Opens with what dx-maps is for: seven objectives, each paired with the gate or section that proves it is met. - New Research Gallery section: the cap-5 app shell and the tree of cap-4..1 plugins it nests, each still independently embeddable. - Plugin Studio: clone main (the old branch was 198 commits behind), a command table, and a fresh studio screenshot (the old one showed a retired nav and tofu icons). - Agent swarm: renamed to industry terms (trunk-based development, merge queue, maintainer), a laptop recipe (worktrees, strict ports, one builder, flock as the queue), and a redrawn diagram whose inner ring is an actual queue with one gate. SVG source committed next to the PNG. - MapLibre is now described as it is: a one-prop, token-free engine. - Removed internal credential/push instructions (AGENT-BRIEF.md covers agents). - documentation/: fixed 19 dead links left by the docs/ move, removed internal references, and listed the working docs in the index. - readme-shots: ONLY= retakes a single image. --- README.md | 421 ++++++++++-------- documentation/CONTRIBUTING.md | 10 +- .../README-SECTION-3-cli-commands.md | 2 +- documentation/README-longform.md | 10 +- documentation/README.md | 8 + documentation/contributing/README.md | 14 +- .../develop-a-plugin-and-see-it-live.md | 4 +- .../readme-images/cap5-plugin-studio.png | Bin 999122 -> 1039157 bytes .../readme-images/delegation-model.png | Bin 233892 -> 178873 bytes .../readme-images/src/delegation-model.svg | 68 +++ documentation/reference.md | 4 +- internal/readme-shots.mjs | 3 + 12 files changed, 336 insertions(+), 208 deletions(-) create mode 100644 documentation/readme-images/src/delegation-model.svg diff --git a/README.md b/README.md index 6790fe48d..8b7f5b715 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# doxa-maps — one build, maps that embed everywhere +# dx-maps — one build, maps that embed everywhere > **The map cruncher.** Many hand-built maps go in; one shared library, one repo and one build > come out — and every map fans out to five deployment targets from the same artifacts. @@ -18,24 +18,99 @@ > (proven) (proven) (built) (built) (built) > ``` - **A Vite bundler that turns each map into a self-contained web component.** Write a map in `plugin-designs//`, run one build, and get a folder you can drop on any host — iframe it, -script-embed it, wrap it as a mobile app, or open every map at once as one SPA. - -This README has three parts, in the order you need them: - -1. **[The 5 plugin capabilities](#1-the-5-plugin-capabilities)** — what you can build, simplest to richest. -2. **[The 5 deployment methods](#2-the-5-deployment-methods)** — where a plugin can run. -3. **[The Plugin Studio](#3-the-plugin-studio)** — ★ where you *work*. Start here if you are new. +script-embed it, wrap it as a mobile app, or open every map at once as one app. --- -## 1. The 5 plugin capabilities — most advanced first +## What dx-maps is for — and how each objective is met + +Maps multiply a prayer movement only when they can live on *every* partner's site, not just one. +dx-maps exists to make that cheap. It set out to meet seven objectives; each one is met by something +you can open or run, not by a claim. + +| # | Objective | How it is met | See it / check it | +|---|-----------|---------------|-------------------| +| 1 | **One build → one folder.** Seven maps that were seven codebases become one repo and one build. | `bun run build` writes a single drop-anywhere tree, `public/doxa-maps/`, with a `manifest.json` describing every bundle. | `bun run check:drop` · `bun run check:settled` | +| 2 | **Every map is embeddable.** Any map, on any site, with a copy-paste snippet. | Each bundle is one custom element; `manifest.json` ships an iframe snippet and an SRI-pinned `