2a328fe68f
Two of the five shipped without one. bebas-neue/LICENSE was 24 lines and poppins/LICENSE 29 -- our own notes files named LICENSE, pointing at openfontlicense.org instead of carrying the text. The OFL requires the licence to travel WITH the font, and these fonts go out in the repo we intend to give away. Both now carry their FAMILY'S OWN upstream OFL, fetched verbatim from google/fonts, which is what brings the real copyright line with it -- Dharma Type for Bebas Neue, the Poppins Project Authors for Poppins. No licence text was authored here. Source URL and sha256 are recorded. figtree keeps its OFL and loses only the six lines of ours that sat above it. Our prose moved to documentation/vendored-fonts.md, OUTSIDE the served tree, and that placement is the whole lesson. My first attempt put a NOTES.md beside each LICENSE, which check:public-hygiene rejected as "documentation in a served folder" -- three new hard findings, plus a fourth for an internal folder name I had relocated with the text. The old bebas-neue LICENSE had said exactly this in its own words, "prose does not belong in a public served folder"; I quoted that line and then did it anyway. The licence travels with the font; the explanation travels with the repo. Whole shipped tree, measured before and after rather than sampled: role nouns 6 -> 0, hygiene warnings 18 -> 14, findings 1 -> 1 (the pre-existing assets/ contract one, not mine). |
||
|---|---|---|
| .. | ||
| architecture | ||
| assets | ||
| contributing | ||
| needs-eyes | ||
| readme-images | ||
| screenshots | ||
| CLOUD-DEVELOPMENT-ENVIRONMENT.md | ||
| 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 | ||
| 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-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.