History

doxa-maps-88655c70 5b3618d0d6 Check that the CLI doc still quotes package.json correctly Applying last tick's lesson -- grep for the class, not the instance -- found a third surface teaching the old serve command. README-SECTION-3-cli-commands.md transcribes the package.json scripts so a reader need not open the file, and it still showed python3 -m http.server two commits after serve became serve-strict.mjs. An inheritor following the CLI reference would have started the permissive server, the one whose forgiveness hid a URL bug in two gates for a whole flight. Measured before fixing: ten quoted scripts, nine matching, exactly one drifted. I had expected build:unlocked to be stale too and it is not -- the doc truncates it rather than misquoting it, which is the right call for a seven-hundred-character line. Hand-fixing the one line would leave the next script change to rot the same way, so the doc is now checked. The comparison is loose in the three ways a human-facing doc needs: package.json's trailing hash comments are ignored, the doc's own slash-slash annotations are ignored, and truncation passes on a prefix match either way. A quoted script that does not exist in package.json is a hard failure, since that is a command someone would type and get "script not found". Completeness is deliberately not asserted; the doc is a curated subset and demanding otherwise would make it churn on every internal gate. Self-test poisons the doc in memory two ways, a changed body and a nonexistent script name, and requires both to be caught. Both are. Full build passes with the gate in the chain.		2026-09-23 04:19:42 +00:00
..
architecture	Document why a gate cannot import plugin source, and stop teaching public binds	2026-09-22 17:40:11 +00:00
assets	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +00:00
contributing	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +00:00
readme-images	Give the README map screenshots their basemap back	2026-09-22 10:16:54 +00:00
screenshots	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +00:00
CONTRIBUTING.md	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +00:00
develop-a-plugin-and-see-it-live.md	Hand an inheritor a token that works, and stop claiming one is present without checking	2026-09-23 04:09:07 +00:00
explanation.md	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +00:00
how-to.md	Land the swarm's work: no iframes anywhere, a tree that keeps its shape, deeper facets	2026-09-22 14:51:52 +00:00
README-embed-example.md	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +00:00
README-longform.md	Checkpoint the swarm's in-flight work	2026-09-22 21:42:18 +00:00
README-SECTION-3-cli-commands.md	Check that the CLI doc still quotes package.json correctly	2026-09-23 04:19:42 +00:00
README.md	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +00:00
reference-capability-exemplars.md	Give nested ProfileLoader children the profile-config they require	2026-09-22 09:37:35 +00:00
reference-library-index.md	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +00:00
reference.md	Fix the same broken token command in reference.md, and say only what was measured	2026-09-23 04:13:45 +00:00
slide-deck-outline.md	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +00:00
tutorial.md	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +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.

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