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,47 @@
# `verae-fleet/machines`
**Package:** `verae-fleet`
**Source:** `packages/verae-fleet/src/machines.js`
**Lines:** 108
## What this module is
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`defaultMachines`, `loadMachines`, `normalizeMachine`, `upsertMachine`, `canHost`, `pickMachine`, `saveOverlay`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `defaultMachines` | `(none)` | — | `unknown` | see Call graph |
| `loadMachines` | `root, overlayPath` | — | `unknown` | see Call graph |
| `normalizeMachine` | `m` | — | `unknown` | see Call graph |
| `upsertMachine` | `list, spec` | — | `unknown` | see Call graph |
| `canHost` | `machine, serviceId, role` | — | `unknown` | see Call graph |
| `pickMachine` | `machines, instances, serviceId, role, exclude = []` | machines: `object[]`, serviceId: `string`, role: `string` | `unknown` | see Call graph |
| `saveOverlay` | `overlayPath, machines` | — | `unknown` | see Call graph |
## What it imports / requires
- `node:fs`
- `node:path`
## Call graph (identifiers invoked)
`defaultMachines`, `plane`, `loadMachines`, `join`, `existsSync`, `parse`, `readFileSync`, `isArray`, `upsertMachine`, `assign`, `map`, `normalizeMachine`, `trim`, `findIndex`, `push`, `canHost`, `includes`, `capacity`, `pickMachine`, `filter`, `has`, `sort`, `localeCompare`, `find`, `saveOverlay`, `mkdirSync`, `dirname`, `writeFileSync`, `stringify`
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`.