doxa-maps/documentation
2026-10-01 00:54:28 +00:00
..
architecture
assets
contributing
how-to-build-mobile-apps-from-plugins Mobile apps from plugins: a how-to, with Deep Research as the worked example 2026-09-30 10:04:34 +00:00
needs-eyes
readme-images Merge #8.6 (the Rudder screenshot) onto #8.5 + #8.7 2026-09-30 22:44:50 +00:00
screenshots
CLOUD-DEVELOPMENT-ENVIRONMENT.md
CONTRIBUTING.md
DEPLOY.md README and docs: no private server address or platform name, and the desktop app works 2026-09-30 22:36:29 +00:00
develop-a-plugin-and-see-it-live.md
explanation.md
how-to.md Mobile apps from plugins: a how-to, with Deep Research as the worked example 2026-09-30 10:04:34 +00:00
HOWTO-build-the-desktop-app.md
HOWTO-join-the-table.md README, HOWTO and .env.example: a changed port takes effect when bun run dev restarts (V8, third fresh reader) 2026-09-29 11:56:47 +00:00
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 Build poster-design, regenerate the tree, SRI and the capability-exemplars table on the merged source 2026-09-30 22:42:56 +00:00
reference-library-index.md PanelSheets: a plain style id, and the library index lists the new poster files 2026-09-30 22:18:46 +00:00
reference-universal-props.md
reference.md README and docs: a plugin's own page is /__leaf/<plugin>/<profile>, and auto is MapLibre 2026-09-29 11:04:22 +00:00
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-config contract.
  • 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:

Nothing on the simple path is longer than a few minutes; everything complex lives in architecture/, linked from where you'd need it.