Document every repo in Sphinx, catalog PDFs, and verae-ops
Some checks are pending
offline / test (push) Waiting to run

Add missing package READMEs, expand Sphinx to all runtime modules,
publish a LaTeX/PDF README book, and add verae-ops for Docker,
Proxmox, VMs, dedicated hardware, and service linking. Catalog
defaults to public PDF links for each module README and samples.
This commit is contained in:
George Lambert 2026-09-11 14:36:17 -04:00
parent 5ad3222def
commit e401635fd6
222 changed files with 4498 additions and 123 deletions

View file

@ -0,0 +1,57 @@
# `verae-fleet/worker`
**Package:** `verae-fleet`
**Source:** `packages/verae-fleet/src/worker.js`
**Lines:** 154
## What this module is
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
_No named `export` / `module.exports` keys detected._
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `processMessage` | `(none)` | — | `unknown` | see Call graph |
| `snapshot` | `(none)` | — | `unknown` | see Call graph |
| `beat` | `(none)` | — | `unknown` | see Call graph |
| `shutdown` | `(none)` | — | `unknown` | see Call graph |
| `json` | `code, obj` | — | `unknown` | see Call graph |
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `json` | `404, { error: 'not found' }` |
| `beat` | `(none)` |
| `clearInterval` | `iv` |
## What it imports / requires
- `node:http`
- `node:fs`
- `node:path`
- `node:crypto`
- `node:url`
- `./rtt.js`
## Call graph (identifiers invoked)
`join`, `cwd`, `toISOString`, `mkdirSync`, `resolve`, `dirname`, `fileURLToPath`, `import`, `put`, `query`, `processMessage`, `bigint`, `randomBytes`, `createHash`, `update`, `digest`, `add`, `snapshot`, `stats`, `beat`, `now`, `writeFileSync`, `stringify`, `createServer`, `writeHead`, `end`, `json`, `slice`, `listen`, `write`, `setInterval`, `max`, `round`, `shutdown`, `clearInterval`, `close`, `exit`, `on`
Each identifier is a call site in this file. Follow the import list to see the defining module; open that modules MD for parameter and return types.
## Return values (how to read this)
- HTTP route handlers return Express `res.json(...)` bodies (see route docs).
- Zapier `perform` functions return a **single object** (creates) or an **array** (triggers/searches).
- Pricing functions return integer **cents** on `Quote.totalCents`.