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,45 @@
# `verae-fleet/load`
**Package:** `verae-fleet`
**Source:** `packages/verae-fleet/src/load.js`
**Lines:** 95
## What this module is
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`FLEET_ROOT`, `readJson`, `loadFleet`, `listServices`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `readJson` | `file` | — | `unknown` | see Call graph |
| `loadFleet` | `root = FLEET_ROOT, opts = {}` | root: `string` | `unknown` | see Call graph |
| `listServices` | `loaded` | — | `unknown` | see Call graph |
## What it imports / requires
- `node:fs`
- `node:path`
- `node:url`
- `./machines.js`
## Call graph (identifiers invoked)
`dirname`, `fileURLToPath`, `resolve`, `readJson`, `parse`, `readFileSync`, `loadFleet`, `join`, `readdirSync`, `sort`, `endsWith`, `push`, `loadMachines`, `relative`, `listServices`, `values`, `map`
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`.