George Lambert
10c663cc0c
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.
30 lines
1.8 KiB
Markdown
30 lines
1.8 KiB
Markdown
# Work log
|
||
|
||
Running record of milestones. Ordered by dependency.
|
||
|
||
| ID | Item | Depends on | Status |
|
||
|----|------|------------|--------|
|
||
| M0 | Import zappier + middleware + research; git checkin | — | done `b4150c8` |
|
||
| M1 | Organize layout + activate app + tests + Zapier setup guide | M0 | done `b814501` |
|
||
| M2 | Git checkin after green tests | M1 | done `b814501` |
|
||
| M3 | Per-module MD (params, callees, returns) | M2 | done (74 modules) |
|
||
| M4 | Sphinx + PDF for every module + 10 models | M3 | done |
|
||
| M5 | Git checkin docs + lessons | M4 | this commit |
|
||
| M6 | Integration hardening (`/v1/add` on zappier, Add Numbers local) | M2 | done for activate-now |
|
||
| M7 | Ready-to-activate final checkin | M5 | this commit |
|
||
|
||
## Learned (M1)
|
||
|
||
- Zapier Platform `perform` runs in Zapier cloud. Add Numbers can be pure arithmetic so a first push needs **no public URL**.
|
||
- CLI on this machine is `zapier-platform` 19.x; app core must match (`19.1.0`).
|
||
- `zapier-platform validate` is structurally sound for `packages/verae-activate`.
|
||
- Hosted path is optional: zappier `POST /v1/add` is free on the rate card (`operationId: add`).
|
||
- Do not mix `zapier-sdk` (consume) with `zapier-platform` (publish).
|
||
|
||
## Learned (M3–M7)
|
||
|
||
- Extracting signatures from JS/TS with regex is good enough for a first API atlas; JSDoc `@param`/`@returns` is sparse in older files — fill those as we touch modules.
|
||
- Sphinx `include` paths are relative to the RST file; copy MD beside RST.
|
||
- Combined reportlab books fail if any flowable is taller than a page; keep one PDF per module.
|
||
- Middleware gates 2–6 and 10 pass with `MOCK_VERAE=true` and NATS off. Gates 7–9/12 still need a local NATS (not required to push Add Numbers).
|
||
- `zapier-platform validate` is clean with `cleanInputData: false` and a docs link on the optional API key field.
|