doxa-life/doxa-maps
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
doxa-maps/documentation
History
Doxa Maps 0f6ecd978d README + diagram: "landing" means only the landing branch 
A change joins the pilot; only the landing branch is landed on. The swarm section and the diagram used
"land" for both, so the harness paragraph, step 5, the kitchen list, the alt text and the diagram's
centre, panel title and second card now say "join". The lock "works like a merge queue": it lets one
change through at a time, while the order comes from the coordinator. The kitchen list says "landing
server", and the glossary says main moves only when a person approves publishing development. The PNG
is re-rendered at 2x from the SVG source.
2026-10-02 18:47:41 +00:00
..
architecture Docs: "reusable by default" in the library guides, and Deep Research by its name 2026-10-01 08:27:04 +00:00
assets consolidate docs into documentation/ and deployment shells into deployment/ 2026-09-21 23:23:23 +00:00
contribute B21 (2/2): documentation/contribute/, a tutorial for taking contributions from a contributor's own forge 2026-10-01 16:35:38 +00:00
contributing Docs: "reusable by default" in the library guides, and Deep Research by its name 2026-10-01 08:27:04 +00:00
deploy B21 (1/2): the GitHub Pages workflow moves into the docs, so it never runs by itself 2026-10-01 16:27:05 +00:00
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 P (repo): neutral wording in the gates and docs, and no private-process checks 2026-10-01 00:25:38 +00:00
readme-images README + diagram: "landing" means only the landing branch 2026-10-02 18:47:41 +00:00
screenshots consolidate docs into documentation/ and deployment shells into deployment/ 2026-09-21 23:23:23 +00:00
CLOUD-DEVELOPMENT-ENVIRONMENT.md A laptop that follows the table says when it needs credentials, and the last main defaults say development 2026-09-29 00:59:14 +00:00
CONTRIBUTING.md CONTRIBUTING: source and build output as two commits in one push (not two pushes), with the two exemptions 2026-09-28 13:05:56 +00:00
DEPLOY.md Docs: "reusable by default" in the library guides, and Deep Research by its name 2026-10-01 08:27:04 +00:00
develop-a-plugin-and-see-it-live.md Docs: "reusable by default" in the library guides, and Deep Research by its name 2026-10-01 08:27:04 +00:00
explanation.md consolidate docs into documentation/ and deployment shells into deployment/ 2026-09-21 23:23:23 +00:00
how-to.md Bible Posters: neutral source comments + CSP note for the text host 2026-10-01 08:44:14 +00:00
HOWTO-build-the-desktop-app.md Docs: "reusable by default" in the library guides, and Deep Research by its name 2026-10-01 08:27:04 +00:00
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 documentation: the browser guard, and ask the repo rather than grepping 2026-09-28 09:07:30 +00:00
PRESET-PLUGIN-STANDARD.md A preset keeps its profile's defaults: instance props merge over the meta config instead of replacing it 2026-09-28 03:12:45 +00:00
README-embed-example.md consolidate docs into documentation/ and deployment shells into deployment/ 2026-09-21 23:23:23 +00:00
README-embed-gospel-resources.md Pin wording: a dot marks a people group, not where it is found 2026-10-02 09:16:04 +00:00
README-SECTION-3-cli-commands.md P (repo): neutral wording in the gates and docs, and no private-process checks 2026-10-01 00:25:38 +00:00
README.md The embed contract, written down for partners 2026-09-26 17:24:55 +00:00
reference-capability-exemplars.md Rebuild bless-india-posters on the merged pilot library 2026-10-02 16:29:39 +00:00
reference-library-index.md Poster section page: its @description; the library index and capability exemplars regenerated; the tree rebuilt 2026-10-02 07:07:18 +00:00
reference-universal-props.md Docs: "reusable by default" in the library guides, and Deep Research by its name 2026-10-01 08:27:04 +00:00
reference.md Docs: "reusable by default" in the library guides, and Deep Research by its name 2026-10-01 08:27:04 +00:00
THIRD-PARTY.md P (repo), follow-up: three more lines without a quote or an agent name 2026-10-01 00:28:26 +00:00
tutorial.md Docs: every build line a reader copies now carries BUILD_ALLOW=1 2026-09-25 03:07:52 +00:00
vendored-font-noto-serif-devanagari.md Move the vendored font's README out of the served folder 2026-09-24 04:15:26 +00:00
vendored-fonts.md Every vendored font ships its own licence 2026-09-28 01:30:47 +00:00
why.md consolidate docs into documentation/ and deployment shells into deployment/ 2026-09-21 23:23:23 +00:00

README.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.