doxa-maps/plugin-designs
Doxa Maps c067a5d069 Dictation fell behind because our own build took every core
Rudder was measured slowing after about 1,400 words while a Tauri build
ran. The word count is incidental — it is a proxy for how long the build had
been going. The speech model runs on the CPU (backend/rudder-engine starts it
with --device cpu), and a Rust build saturates every core, so at equal priority
it starves the one process whose latency a person can hear.

Three changes, and the direction of the first is forced rather than chosen:

1. internal/desktop-build.mjs nices the whole build tree to 10, through the one
   run() helper every step goes through, so cargo, rustc and the linker inherit
   it. We nice the COMPETITOR because an unprivileged process cannot raise its
   own priority on Linux — a negative nice needs CAP_SYS_NICE — so "promote the
   ASR" would fail with EPERM. If nice(1) is missing the build still runs and
   says so, because a silent fallback would look exactly like the fix working.

2. cargo is capped at cores-1. nice decides who wins a CONTESTED core; it does
   not stop the build taking all of them, and a fully subscribed machine still
   adds scheduling latency to the audio path. An explicit CARGO_BUILD_JOBS is
   honoured rather than overridden.

3. yieldCPU reports its error instead of discarding it. It was
   `_ = syscall.Setpriority(...)`, which cannot fail visibly — a call that
   silently does nothing is indistinguishable from one that worked, and this one
   guards something audible.

Also, one real O(n) in the widget, found while checking studio's answer that the
collapsed pill already shows the last words: sendActivity split the ENTIRE draft
on every activity tick to take five words. Measured at 3,000 words: 1.61ms per
tick against 0.051ms for a bounded tail, 31x, with byte-identical output.

Verify the priority work with `ps -o ni=` on the running cargo processes, never
by any of these calls returning.
2026-09-29 05:26:25 +00:00
..
all-people-groups All People Groups: no DOXA group is drawn twice; the base is re-sent slim without them 2026-09-29 02:53:16 +00:00
big-picture Keep the reason, drop the speaker 2026-09-29 03:46:37 +00:00
cities-internet The embedded map drew 340px below its card, and said nothing for the 30s it took 2026-09-28 23:43:44 +00:00
country-map Say what <doxa-country-map> is, so the gate and the gallery both have an answer 2026-09-29 02:35:36 +00:00
country-posters Country Posters and the UPG-100 wall read in the page's language, and walls count in each language's plural forms 2026-09-29 05:26:23 +00:00
dashboard-plus-grid Keep the reason, drop the speaker 2026-09-29 03:46:37 +00:00
demo-map Five plugins were silently monolingual, because the bootstrap was copied sixteen times 2026-09-28 17:40:34 +00:00
doxa-maps-spa Comments state their findings instead of citing files outside the repo 2026-09-29 03:46:37 +00:00
doxa-research-map Keep the reason, drop the speaker 2026-09-29 03:46:37 +00:00
doxa-simple-map Prayer Progress: the basemap colours' comment states the measurement instead of citing a folder outside the repo 2026-09-29 03:38:57 +00:00
doxa-vision-card Every Experimental map carries its own hosted ?, where its controls already are 2026-09-29 02:35:35 +00:00
golden-path-check golden-path-check finds its manifest from its own script, so it answers when embedded 2026-09-28 23:23:58 +00:00
gospel-internet Keep the reason, drop the speaker, in the poster comment 2026-09-29 04:44:37 +00:00
gospel-resources Arabic readers get the language code, the link gap and the population column on the wrong side 2026-09-28 23:43:44 +00:00
key-cities Eleven plugin entries import the element helper they call 2026-09-28 17:40:35 +00:00
my-upg-100-list The UPG-100 list prints its packets through the shared lift, not a second copy of it 2026-09-29 05:26:23 +00:00
people-groups-grid The grid's "controls off" preset did nothing, and nothing said so 2026-09-28 22:25:30 +00:00
plugin-studio The Plugin Studio's tree says why it imitates VS Code without pointing outside the repo 2026-09-29 03:22:40 +00:00
pplr-data-maps PPLR Data Maps: on a phone the ten views are one select, and the prayer map's coach-mark stays off this research tool 2026-09-29 05:17:38 +00:00
prayer-walk-planner Prayer Walk Planner: on a phone the zone list opens from a ☰ Zones button instead of being hidden 2026-09-29 02:58:03 +00:00
regions-dashboard Translate the three poster-wall nouns the regions list was passing in English 2026-09-29 04:51:30 +00:00
research-dashboard Keep the reason, drop the speaker 2026-09-29 03:46:37 +00:00
research-map-plus-grid Keep the reason, drop the speaker 2026-09-29 03:46:37 +00:00
rudder-voice Dictation fell behind because our own build took every core 2026-09-29 05:26:25 +00:00
stack-demo Decouple prose: no go-base / nuxtbase / nuxtinator / doxa-base names in plugin comments and docs 2026-09-26 17:28:45 +00:00
template-bundle template-bundle: each screen carries its meta.json, so a copy of the starter is listed in the Plugin Studio 2026-09-29 02:01:33 +00:00
upg-neighbor UPG Neighbor: print a prayer packet of a reached group's unreached neighbours, on the shared packet renderer 2026-09-29 01:54:37 +00:00
wall-of-people-groups Wall of People Groups: the verse file's comments name the brief and the chosen footer, not a person 2026-09-29 05:17:38 +00:00
.gitkeep Rename app-profiles -> plugin-designs; build green under new naming (load-bearing paths updated, guards pass) 2026-09-17 18:18:18 +00:00
README.md plugin-designs/README: the tree is dx-maps, and a bundle's tag is its folder name 2026-09-26 01:19:53 +00:00

plugin-designs/ — where YOUR maps live

The shared template lives in ../library/ (aliased @map) — you never edit it per-map. You build your map by making a folder here, plugin-designs/<your-map>/, and composing the template's building blocks. Your folder is yours (colors, API, i18n); the template is shared (Apache-2.0, propagated to every map on the next build).

Shared vs. yours — the balance

  library/  (@map)  ── SHARED, reusable, parameterized ──►  legend · map · map-controls
        │                                                    (every map reuses these)
        │  imported by
        ▼
  plugin-designs/<your-map>/  ── YOURS ──►  the map's "main" class (the .vue profile = the Vue
        │                                  instance for that map)
        └── src/            ── YOURS ──►  this map's OWN non-reusable components, colors, API, utils

  One bundle can hold as many maps as you want — add another .vue profile and rebuild.
  • Reusable → library/. The legend, the map, the map-controls are shared, parameterized components every map reuses. Fix once, every map benefits. Never edit it to customize one map.
  • This map's own → plugin-designs/<your-map>/. It holds two things: the map's "main" class (each .vue profile is the Vue instance for that map) and that map's own non-reusable 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

plugin-designs/<your-map>/     ← one FOLDER = one BUNDLE, named after the folder
   ├── index.js               ← entry: registers the custom element, finds the profiles
   ├── overview.vue           ← one .vue = one PROFILE (flat in the folder — no profiles/ subfolder)
   └── detail.vue             ← another profile in the SAME bundle

     builds to ─────────────► public/dx-maps/<your-map>/<your-map>.js   (one file)
  • Folder name = bundle name. Folders starting with _ or . are skipped (handy for WIP).
  • Each .vue = one profile (one map screen). One bundle can hold many.
  • Pick the profile at embed time with the profile field — every profile shares one bundle:
<script src="/dx-maps/<your-map>/<your-map>.js"></script>
<your-map profile-config='{"profile":"overview","tk":"pk.eyJ..."}'></your-map>
<your-map profile-config='{"profile":"detail","tk":"pk.eyJ..."}'></your-map>

Add a map — three steps

# 1. create the folder + one profile
mkdir -p plugin-designs/<your-map>
#    index.js   ← copy doxa-simple-map/index.js, rename the tag
#    <name>.vue ← your screen, built from @map/* blocks (flat in the folder)

# 2. build
npm run build            # → public/dx-maps/<your-map>/<your-map>.js
#    (just this one:  BUNDLE=<your-map> npm run build:bundle)

# 3. embed the script tag + element (dev staging at `npm run dev` shows a paste-ready snippet)

Your three things (everything else is shared)

  • Colors — how pins are colored. Pick one the template ships (getColorStrategy('language-family')), or drop your own in plugin-designs/<your-map>/src/colors/ (start from template-bundle/src/colors/example-mode.js). Never edit @map/colors/ to recolor your map.
  • API — your map reads its data from the profile-config on the page, so the same bundle points at different data with no rebuild. DataSourceManager accepts csv (bundled file), api (one JSON URL), or rest-api (a live REST endpoint, the default). Prefer the real API over inlined JSON.
  • i18n — the template ships 11 base locales in @map/i18n/locales/. Use useI18n() for strings and RTL_LOCALES for right-to-left; add or override strings from your own profile.

The one hosting variable

The only thing that changes between hosting modes is the <script src>: a relative path when your own site serves the file, or an absolute CDN URL when a partner site serves it. The bundle is identical either way. See ../documentation/CONTRIBUTING.md for the two CDN modes and partner-site embedding.

Profile patterns (mix freely)

  • Individual — one .vue per bundle (simplest).
  • Parameterized — one profile, behavior driven by profile-config props (e.g. tabs[]).
  • Nested — one profile that renders others (workbench-style, like doxa-research-map).

See also

  • doxa-simple-map/index.js — fully commented reference bundle entry
  • template-bundle/ — minimal two-profile skeleton to copy
  • ../library/colors/README.md — the color-strategy contract
  • ../README.md — repo overview & build pipeline · ../documentation/CONTRIBUTING.md — build vs dev, CDN modes