|
Some checks are pending
build-gate / build (push) Waiting to run
Running the gate list I completed last tick, two entries reported FAIL: smoke:gallery and smoke:share. Neither is a defect. smoke:gallery needs a dev server on :5174 and says so; smoke:share needs --url arguments and prints usage. Both exit non-zero, so in a batch run they read exactly like the real failures the list exists to surface. A checklist that turns a precondition into a red line trains its reader to ignore red lines, which is how a real failure gets skipped. Added a preconditions table stating what each needs and what a bare run actually does, measured by running them. Also recorded that the token-dependent gates DEGRADE rather than fail: without MAPBOX_TOKEN, smoke:embeds reports map profiles as timeouts -- it once read 27/40 for that reason and 40/40 with a token. A timeout there means "no token" far more often than "broken plugin". Two claims corrected before shipping. I wrote that the token endpoint needs a browser User-Agent; measured, a plain curl gets 200 identically -- that requirement belongs to pray.doxa.life, a different host. And I tested rather than asserted the limitation now in the doc: verify:map-paint PASSES on a leaf whose tiles 403, because a live GL context, a sized canvas and attribution are all true while the basemap stays empty. The gate is correctly scoped; the name invites over-reading, so the scope is now written down. |
||
|---|---|---|
| .. | ||
| architecture | ||
| assets | ||
| contributing | ||
| readme-images | ||
| screenshots | ||
| CONTRIBUTING.md | ||
| develop-a-plugin-and-see-it-live.md | ||
| explanation.md | ||
| how-to.md | ||
| README-embed-example.md | ||
| README-longform.md | ||
| README-SECTION-3-cli-commands.md | ||
| README.md | ||
| reference-capability-exemplars.md | ||
| reference-library-index.md | ||
| reference.md | ||
| slide-deck-outline.md | ||
| tutorial.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.
Nothing on the simple path is longer than a few minutes; everything complex lives in
architecture/, linked from where you'd need it.