From 08dca05f6392528fc49ab835fb91e35cdfc63357 Mon Sep 17 00:00:00 2001 From: doxa-maps-88655c70 <88627970+doxa-maps-88655c70@users.noreply.github.com> Date: Fri, 25 Sep 2026 03:29:36 +0000 Subject: [PATCH] Golden path: a six-step table first, the incident notes in a log at the bottom The first doc a DX developer follows now opens with one table (what you do, the command, what "done" looks like), then one short section per step with its command. The nine dated measurement notes move, unabridged in substance, to a "Notes and history" log at the end. 2,612 -> 1,501 words. Also corrected two stale facts: the deployment status table now matches the README (WordPress and Tauri are proofs of concept; mobile is built), and the Experimental shelf is described as it works, not by a 2026-09-21 row list that no longer matches. --- .../develop-a-plugin-and-see-it-live.md | 309 ++++++------------ 1 file changed, 104 insertions(+), 205 deletions(-) diff --git a/documentation/develop-a-plugin-and-see-it-live.md b/documentation/develop-a-plugin-and-see-it-live.md index 527bb4acb..9eb37531d 100644 --- a/documentation/develop-a-plugin-and-see-it-live.md +++ b/documentation/develop-a-plugin-and-see-it-live.md @@ -1,32 +1,32 @@ # Develop a plugin and see it live — the golden path -> **The one thing that matters:** author a map plugin, run one build, and see it live on the platform. -> This page THREADS the existing docs into that read-order — it does not duplicate them. Follow the six -> steps; each links to the doc that teaches that piece in depth. Brand-neutral: any team on any platform -> inherits this same path. +**Author a map plugin, build it once, prove it mounts, and see it live — in six steps.** Each step links +to the doc that teaches that piece in depth. -## The path at a glance +| Step | You do | Command | Done when | +|---|---|---|---| +| **1. Pick a capability** | choose how much your plugin nests | — | you know your tier (1–5) | +| **2. Author** | write 3 files in `plugin-designs//` | — | the folder has `.vue` + `index.js` + `index.html` | +| **3. See it in the studio** | iterate with hot reload, no build | `bun run dev` | your plugin appears at http://localhost:5173/ | +| **4. Build** | produce the deployable tree | `BUILD_ALLOW=1 bun run build` | exit 0, all guards PASS | +| **5. Prove it mounts** | open every plugin in a real browser | `bun run smoke:embeds` | `N/N pages mount cleanly` | +| **6. Publish and see it live** | copy the tree to your host, embed it | see Step 6 | the live URL shows it | -``` - author build publish see it live - plugin-designs/ → bun run build → merge to catalog → https:///plugin-assets/… - (one folder) (one step) (the runbook) (a tab, an iframe, a