Milestone 2: module/model docs (MD, Sphinx RST, PDF) and work log

74 source modules documented with extracted signatures, JSDoc params,
imports, and call graphs. 10 first-class models (PriceRule through
StatusResponse) have their own MD/RST/PDF. Sphinx HTML builds from
docs/sphinx. Per-module PDFs in docs/modules-pdf and docs/models-pdf.

Middleware gates 2–6 and 10 pass on MOCK_VERAE without NATS.

Learned: RST includes are relative to the RST file; keep one PDF per
module; Add Numbers remains the only push required tomorrow.
This commit is contained in:
George Lambert 2026-09-09 02:44:51 -04:00
parent b814501441
commit 10c663cc0c
347 changed files with 17200 additions and 14 deletions

26
docs/models/PriceRule.md Normal file
View file

@ -0,0 +1,26 @@
# PriceRule
**Kind:** discriminated union
**Defined in:** `packages/zappier/src/pricing.ts`
## Fields
| Field | Type | Meaning |
|-------|------|---------|
| `kind` | `'free' | 'fixed' | 'variable'` | Which list-price formula |
| `fixedCents` | `number?` | When kind=fixed, cents per call |
| `baseCents` | `number?` | When kind=variable, base cents |
| `perKbCents` | `number?` | When kind=variable, per KB metadata |
| `perMbCents` | `number?` | When kind=variable, per MB attachments |
## Who constructs it
RateCard.endpoints values
## Who consumes it
`quoteCall`, `meter`, `admin rate card UI`, `portal API & pricing tab`
## Related modules
See `docs/modules/` for the functions that take these types as parameters and the values they return.