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
commit e401635fd6
138 changed files with 4499 additions and 124 deletions

View file

@ -4,4 +4,4 @@ verae-activate.authentication
Generated API sheet for ``verae-activate/authentication``.
.. include:: authentication.md
:literal:
:parser: myst_parser.sphinx_

View file

@ -4,4 +4,4 @@ verae-activate.creates.add_numbers
Generated API sheet for ``verae-activate/creates/add_numbers``.
.. include:: add_numbers.md
:literal:
:parser: myst_parser.sphinx_

View file

@ -4,4 +4,4 @@ verae-activate.creates.echo
Generated API sheet for ``verae-activate/creates/echo``.
.. include:: echo.md
:literal:
:parser: myst_parser.sphinx_

View file

@ -4,4 +4,4 @@ verae-activate.creates.sha256
Generated API sheet for ``verae-activate/creates/sha256``.
.. include:: sha256.md
:literal:
:parser: myst_parser.sphinx_

View file

@ -4,4 +4,4 @@ verae-activate.creates.timestamp
Generated API sheet for ``verae-activate/creates/timestamp``.
.. include:: timestamp.md
:literal:
:parser: myst_parser.sphinx_

View file

@ -4,4 +4,4 @@ verae-activate.index
Generated API sheet for ``verae-activate/index``.
.. include:: index.md
:literal:
:parser: myst_parser.sphinx_

View file

@ -0,0 +1,41 @@
# `verae-archive-aggregator/aggregate`
**Package:** `verae-archive-aggregator`
**Source:** `packages/verae-archive-aggregator/src/aggregate.js`
**Lines:** 67
## What this module is
Implementation module in `verae-archive-aggregator`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`aggregateAttached`, `mergeReceipts`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `aggregateAttached` | `{ sha256, tenantId, kinds = ['publicMeta', 'privateMeta', 'file'], archives }` | opts: `object`, opts.sha256: `string`, opts.tenantId: `string`, opts.kinds: `string[]`, opts.timeoutMs: `number` | `{ archivesQueried: boolean, archiveReplies: number, records: object[], silent: string[] ` — } | see Call graph |
| `mergeReceipts` | `chainReceipts, archiveRecords` | chainReceipts: `object[]`, archiveRecords: `object[]` | `unknown` | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`mock`, `aggregateAttached`, `query`, `push`, `includes`, `mergeReceipts`, `map`
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.

View file

@ -0,0 +1,7 @@
verae-archive-aggregator.aggregate
==================================
Generated API sheet for ``verae-archive-aggregator/aggregate``.
.. include:: aggregate.md
:parser: myst_parser.sphinx_

View file

@ -0,0 +1,48 @@
# `verae-archive-worm/archive`
**Package:** `verae-archive-worm`
**Source:** `packages/verae-archive-worm/src/archive.js`
**Lines:** 41
## What this module is
Implementation module in `verae-archive-worm`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`WormArchive`
## Types / interfaces / classes
| Kind | Name |
|------|------|
| class | `WormArchive` |
## Functions
_No top-level functions extracted._
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `constructor` | `archiveId` |
| `put` | `put` |
| `query` | `sha256` |
## What it imports / requires
- `./bloom.js`
## Call graph (identifiers invoked)
`constructor`, `put`, `toLowerCase`, `get`, `push`, `toISOString`, `set`, `add`, `null`, `records`, `query`, `mightHave`
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.

View file

@ -0,0 +1,7 @@
verae-archive-worm.archive
==========================
Generated API sheet for ``verae-archive-worm/archive``.
.. include:: archive.md
:parser: myst_parser.sphinx_

View file

@ -0,0 +1,49 @@
# `verae-archive-worm/bloom`
**Package:** `verae-archive-worm`
**Source:** `packages/verae-archive-worm/src/bloom.js`
**Lines:** 47
## What this module is
Implementation module in `verae-archive-worm`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`Bloom`
## Types / interfaces / classes
| Kind | Name |
|------|------|
| class | `Bloom` |
## Functions
_No top-level functions extracted._
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `constructor` | `m = 16384, k = 4` |
| `hashes` | `s` |
| `add` | `s` |
| `mightHave` | `s` |
## What it imports / requires
- `node:crypto`
## Call graph (identifiers invoked)
`membership`, `constructor`, `alloc`, `ceil`, `hashes`, `createHash`, `update`, `digest`, `readUInt32BE`, `push`, `add`, `maybe`, `mightHave`, `every`
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.

View file

@ -0,0 +1,7 @@
verae-archive-worm.bloom
========================
Generated API sheet for ``verae-archive-worm/bloom``.
.. include:: bloom.md
:parser: myst_parser.sphinx_

View file

@ -0,0 +1,51 @@
# `verae-fleet/agent`
**Package:** `verae-fleet`
**Source:** `packages/verae-fleet/src/agent.js`
**Lines:** 87
## What this module is
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`startAgent`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `json` | `res, code, obj` | — | `unknown` | see Call graph |
| `readBody` | `req` | — | `unknown` | see Call graph |
| `startAgent` | `{ port = PORT, bind = BIND } = {}` | — | `unknown` | see Call graph |
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `startAgent` | `(none)` |
## What it imports / requires
- `node:http`
- `node:child_process`
- `node:path`
- `node:url`
## Call graph (identifiers invoked)
`join`, `dirname`, `fileURLToPath`, `json`, `writeHead`, `end`, `stringify`, `readBody`, `push`, `concat`, `toString`, `parse`, `startAgent`, `createServer`, `async`, `keys`, `has`, `get`, `spawn`, `set`, `on`, `delete`, `kill`, `listen`, `write`, `close`, `values`, `clear`, `basename`
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.

View file

@ -0,0 +1,7 @@
verae-fleet.agent
=================
Generated API sheet for ``verae-fleet/agent``.
.. include:: agent.md
:parser: myst_parser.sphinx_

View file

@ -0,0 +1,40 @@
# `verae-fleet/classify`
**Package:** `verae-fleet`
**Source:** `packages/verae-fleet/src/classify.js`
**Lines:** 30
## What this module is
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`classifyService`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `classifyService` | `sv` | — | `'operational'|'degraded'|'down'` | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`classifyService`, `filter`
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.

View file

@ -0,0 +1,7 @@
verae-fleet.classify
====================
Generated API sheet for ``verae-fleet/classify``.
.. include:: classify.md
:parser: myst_parser.sphinx_

View file

@ -0,0 +1,62 @@
# `verae-fleet/cli`
**Package:** `verae-fleet`
**Source:** `packages/verae-fleet/src/cli.js`
**Lines:** 146
## 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) |
|------|------------|---------------------|---------|-----------------------------|
| `print` | `obj` | — | `unknown` | see Call graph |
| `help` | `(none)` | — | `unknown` | see Call graph |
| `api` | `method, pathname` | — | `unknown` | see Call graph |
| `main` | `(none)` | — | `unknown` | see Call graph |
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `print` | ``verae-fleet
list services, config files, replica min/max
serve start floors + monitor + UI ${BASE}/
monitor same without printing extra
status GET daemon status
start <service> turn on, spawn up to min
stop <service|instance> turn off (service disable` |
| `print` | `r.body` |
| `print` | `{ error: err.message, hint: 'Is `verae-fleet serve` running?' }` |
## What it imports / requires
- `node:http`
- `./load.js`
- `./supervisor.js`
- `./monitor.js`
- `./server.js`
## Call graph (identifiers invoked)
`loadFleet`, `slice`, `print`, `write`, `stringify`, `help`, `off`, `pause`, `json`, `identityFile`, `login`, `api`, `request`, `on`, `push`, `concat`, `toString`, `resolve`, `parse`, `end`, `main`, `listServices`, `padEnd`, `padStart`, `import`, `find`, `sshCheck`, `keys`, `startService`, `tick`, `start`, `startControlServer`, `async`, `stop`, `stopAll`, `exit`, `test`
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.

View file

@ -0,0 +1,7 @@
verae-fleet.cli
===============
Generated API sheet for ``verae-fleet/cli``.
.. include:: cli.md
:parser: myst_parser.sphinx_

View file

@ -0,0 +1,47 @@
# `verae-fleet/health`
**Package:** `verae-fleet`
**Source:** `packages/verae-fleet/src/health.js`
**Lines:** 119
## What this module is
Implementation module in `verae-fleet`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`httpProbe`, `tcpProbe`, `postControl`, `heartbeatFresh`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `httpProbe` | `portOrOpts, pathname = '/health', timeoutMs = 800` | — | `unknown` | see Call graph |
| `tcpProbe` | `host, port, timeoutMs = 400` | — | `unknown` | see Call graph |
| `postControl` | `portOrOpts, pathname = '/'` | pathname: `string` | `unknown` | see Call graph |
| `heartbeatFresh` | `stateDir, maxAgeMs` | — | `unknown` | see Call graph |
| `done` | `ok, error` | — | `unknown` | see Call graph |
## What it imports / requires
- `node:http`
- `node:net`
- `node:fs`
- `node:path`
## Call graph (identifiers invoked)
`httpProbe`, `get`, `on`, `push`, `parse`, `concat`, `toString`, `resolve`, `destroy`, `tcpProbe`, `connect`, `setTimeout`, `done`, `postControl`, `stringify`, `request`, `byteLength`, `write`, `end`, `heartbeatFresh`, `join`, `statSync`, `readFileSync`, `now`
Each identifier is a call site in this file. Follow the import list to see the defining module; open that module’s 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`.

View file

@ -0,0 +1,7 @@
verae-fleet.health
==================
Generated API sheet for ``verae-fleet/health``.
.. include:: health.md
:parser: myst_parser.sphinx_

Some files were not shown because too many files have changed in this diff Show more