f2e2509167
Follow-up to the doc landing in 49, which was written before the guard existed. Adds the guard: every browser gate reaches Playwright through internal/lib/playwright-guarded.mjs and refuses unless browser-slot.sh exported DOXA_BROWSER_SLOT; an unslotted run exits 75 with the command to use, quoted verbatim. And says the slot is a COUNTING SEMAPHORE, not a mutex, with the reason from its own header -- a single lock queued 10-19 deep for hours because the real constraint is memory, ~300-500MB per chrome, not exclusivity. Replaces the grep advice with `bun run browser-gates`. The grep still works and is fine for a quick look, but it is a heuristic over file text: my own count from grepping internal/check-*.mjs said 87 browser gates; the repo's own detector says 97, because browser gates also live in plugin-designs/*/scripts/. Corrected. The authoritative list cannot drift from what is enforced, because check:browser-gates-guarded uses the same detector. One line the guard's header earns and this doc had not stated: being able to launch is not the same as it being yours to launch. The guard stops the accident; it does not hand a newcomer the seat. Testing whether the guard refuses is itself a browser launch. Does NOT claim path-into-node_modules detection: studio has that in landing 50, and it is not in this tree, so the doc does not describe it yet. |
||
|---|---|---|
| .. | ||
| architecture | ||
| assets | ||
| contributing | ||
| needs-eyes | ||
| readme-images | ||
| screenshots | ||
| CLOUD-DEVELOPMENT-ENVIRONMENT.md | ||
| CONTRIBUTING.md | ||
| DEPLOY.md | ||
| develop-a-plugin-and-see-it-live.md | ||
| explanation.md | ||
| how-to.md | ||
| HOWTO-build-the-desktop-app.md | ||
| HOWTO-join-the-table.md | ||
| HOWTO-which-gates-need-a-browser.md | ||
| PRESET-PLUGIN-STANDARD.md | ||
| README-embed-example.md | ||
| README-embed-gospel-resources.md | ||
| README-SECTION-3-cli-commands.md | ||
| README.md | ||
| reference-capability-exemplars.md | ||
| reference-library-index.md | ||
| reference-universal-props.md | ||
| reference.md | ||
| THIRD-PARTY.md | ||
| tutorial.md | ||
| vendored-font-noto-serif-devanagari.md | ||
| vendored-fonts.md | ||
| why.md | ||
documentation/ — 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-configcontract. - 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.
- README-embed-gospel-resources.md — the gospel map's URL contract for partner embeds: bring your own ISO 639-3 list, one country, one group, or the zero-access view.
Working on the repo:
- develop-a-plugin-and-see-it-live.md — ★ the golden path: zero to a plugin live, in 6 steps.
- README-SECTION-3-cli-commands.md — every command, per deployment method, with prerequisites.
- reference-capability-exemplars.md — which bundle is at which capability tier (generated).
- reference-library-index.md — the reusable
library/pieces you can import (generated). - CONTRIBUTING.md and contributing/ — how to contribute, and the bar for
library/.
Nothing on the simple path is longer than a few minutes; everything complex lives in
architecture/, linked from where you'd need it.