doxa-maps/documentation
Doxa Maps 5311a16e0c
Some checks are pending
Deploy to GitHub Pages / build (push) Waiting to run
Deploy to GitHub Pages / deploy (push) Blocked by required conditions
Update from source 33362f559
2026-09-28 09:40:13 +00:00
..
architecture Update from source 7c360016f 2026-09-28 07:37:08 +00:00
assets Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
contributing Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
needs-eyes Update from source 8e49ec41 2026-09-26 01:22:22 +00:00
readme-images Update from source ee1cbc05 2026-09-27 10:21:12 +00:00
screenshots Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
CLOUD-DEVELOPMENT-ENVIRONMENT.md Update from source cce2a5c90 2026-09-28 01:44:36 +00:00
CONTRIBUTING.md Update from source 94f0e554 2026-09-25 22:19:32 +00:00
DEPLOY.md Update from source 7077c5550 2026-09-28 03:53:39 +00:00
develop-a-plugin-and-see-it-live.md Update from source 94f0e554 2026-09-25 22:19:32 +00:00
explanation.md Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
how-to.md Update from source 52eeb0db 2026-09-26 18:08:09 +00:00
HOWTO-build-the-desktop-app.md Update from source 7c360016f 2026-09-28 07:37:08 +00:00
HOWTO-join-the-table.md Update from source 4244c9097 2026-09-28 02:15:02 +00:00
HOWTO-which-gates-need-a-browser.md Update from source 33362f559 2026-09-28 09:40:13 +00:00
PRESET-PLUGIN-STANDARD.md Update from source bbcc52cbc 2026-09-28 03:38:45 +00:00
README-embed-example.md Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
README-embed-gospel-resources.md Update from source a37ea4ff 2026-09-27 06:02:07 +00:00
README-SECTION-3-cli-commands.md Update from source f1f93d78 2026-09-26 04:20:35 +00:00
README.md Update from source 91ea64f8 2026-09-26 18:43:40 +00:00
reference-capability-exemplars.md Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
reference-library-index.md Update from source 7c360016f 2026-09-28 07:37:08 +00:00
reference-universal-props.md Update from source d3d3c3f8 2026-09-26 11:59:17 +00:00
reference.md Update from source 94f0e554 2026-09-25 22:19:32 +00:00
THIRD-PARTY.md Update from source 7077c5550 2026-09-28 03:53:39 +00:00
tutorial.md Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
vendored-font-noto-serif-devanagari.md Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00
vendored-fonts.md Update from source 713838577 2026-09-28 01:55:19 +00:00
why.md Doxa Maps — the map bundler, 7 production plugins and the Experimental shelf 2026-09-25 20:07:59 +00:00

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.