3de124209a
repo answered with the names as they will ship (END-REPO-ENVNAMES) and dx-shepherd caught a path I had wrongly removed. Both corrected; the doc now states nothing I have not verified. ⚠ MY "THE PATH DOES NOT EXIST" CHECK WAS WRONG, AND WRONG IN AN INSTRUCTIVE WAY. I searched the LAST COMMIT's file list for pb_migrations and found nothing, then reported the path as unbuilt. `git ls-tree -r origin/main` shows backend/pocketbase/pb_migrations/.gitkeep — it has been there all along. A file list from one commit answers "was this touched recently", never "does this exist"; I asked the cheap question and read it as the expensive one. The real path is restored. THREE CORRECTIONS FROM repo, each of which would have cost a reader time: - DX_SYNC_REMOTE is a remote NAME (`origin`), not a URL. My draft said "<the repo URL>", which would have failed silently for every joiner who copied it. - DX_PB_URL IS OUT ENTIRELY. repo was explicit: it points at the shared database, which sits behind the team sign-in and does not work from a laptop. Telling a newcomer to set it would have sent them to debug an auth wall on their first afternoon. What replaced it is the truth — `bun run dev` downloads and starts a local database itself, and there is nothing to configure. - VITE_MAPBOX_TOKEN is the one credential they must ask for, and my draft never mentioned it. A joiner following the old page would have got a working repo and a blank map. ALSO ADDED, because it is the behaviour that makes the feature safe to recommend: the auto-pull only runs when you are on that branch, with no unsaved edits and no local commits. Otherwise it does not touch your files, it says "main is N commits ahead … pull when ready" in the log. That is the difference between a feature a newcomer trusts and one they turn off after it eats an afternoon's work. Required set is now stated plainly: DX_SYNC_REMOTE=origin if you want teammates' work to arrive, plus the Mapbox token. Everything else optional, with its default in a table. No internal names, re-checked after the rewrite: the only product name left is PocketBase, which a joiner sees in its own admin UI. |
||
|---|---|---|
| .. | ||
| architecture | ||
| assets | ||
| contributing | ||
| needs-eyes | ||
| readme-images | ||
| screenshots | ||
| CONTRIBUTING.md | ||
| develop-a-plugin-and-see-it-live.md | ||
| explanation.md | ||
| how-to.md | ||
| HOWTO-join-the-table.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 | ||
| tutorial.md | ||
| vendored-font-noto-serif-devanagari.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.