Your browser sucks, JavaScript disabled! Gunnar's console needs JavaScript and WebAssembly. Git over SSH on port 2222 does not.

nordisk/monetize

docs/v2/README.md

monetize v2 — the manual

Written from the code on monetize main c9b473a5 and the kit (private-monetize-ops main 3265880) on 2026-11-04. Every statement is checked against the code; the file:line after a statement is where it stands. Self-contained: an outside reader needs no checkout.

chapter what it answers
1. What monetize is the ONE box, products, estates, sites, sold estates, accounts, the shop, the Guardian, the test buy; who runs it
2. The architecture and the plugin model the processes, the crates, the five plugin kinds, how the feed installs them, held plugins, plugin update, the box's own update paths
3. Write a plugin per kind, the exact trait to implement, every method, required vs defaulted, the sandbox numbers, the block, and a compiling skeleton (examples/)
4. The buy flow and the money Stripe once, e-mail once, "Pay "; the pricing and margin math in full with worked examples; the term, grace, nonpay and deletion timing; budgets and caps; the transaction
5. The estate lifecycle lay, pairing and the keys, the pull channel and fleet_at, the self-heal re-feed, upgrades and anti-rollback, grow, the term's actions, terminate, the Guardian and the fence invariant
6. The data model the five rules, the stores, the ledger grammar, the purchase, the signed fact, the run, the account records, who signs what
7. The operator console and the CLI every page and button as the console has them; every CLI verb
8. The security model the doors, the keys, the sandbox, what an operator can and cannot do, what never crosses the ABI
9. Operator alerts every ALERT <code> the box writes, its severity, who acts, what to do (held to the code by a test)
The idiot guide get a box, feed it, add a site, test buy, sell, upgrade, terminate — click by click (also docs/idiot_guide-v2.pdf)

The pictures are generated: python3 docs/v2/img/draw.py docs/v2/img (edit draw.py, never an SVG). The plugin skeletons compile against main: cargo build -p monetize-example-product … and cargo xtask build-guests build them.

What is not here: the release procedure (docs/RELEASING.md), the security policy (SECURITY.md), the licences (COMMERCIAL-LICENSING.md, LICENSES/).