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,40 @@
# `verae-nats-process/handle`
**Package:** `verae-nats-process`
**Source:** `packages/verae-nats-process/src/handle.js`
**Lines:** 21
## What this module is
Implementation module in `verae-nats-process`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`handle`
## Types / interfaces / classes
_None extracted._
## Functions
| Name | Parameters | Param types (JSDoc) | Returns | Calls (same file / helpers) |
|------|------------|---------------------|---------|-----------------------------|
| `handle` | `msg = {}` | msg: `object` | `Promise<object>|object` | see Call graph |
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`handle`, `toISOString`
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`.

View file

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

View file

@ -0,0 +1,38 @@
# `verae-nats-process/subjects`
**Package:** `verae-nats-process`
**Source:** `packages/verae-nats-process/src/subjects.js`
**Lines:** 14
## What this module is
Implementation module in `verae-nats-process`. The tables below are extracted from the source (signatures + JSDoc).
## Exports
`AREA`, `RESOURCE`, `SUBJECTS`
## Types / interfaces / classes
_None extracted._
## Functions
_No top-level functions extracted._
## What it imports / requires
_No imports detected._
## Call graph (identifiers invoked)
`freeze`
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`.

View file

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

View file

@ -0,0 +1,49 @@
# `verae-nats-process/worker`
**Package:** `verae-nats-process`
**Source:** `packages/verae-nats-process/src/worker.js`
**Lines:** 71
## What this module is
Implementation module in `verae-nats-process`. 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) |
|------|------------|---------------------|---------|-----------------------------|
| `snapshot` | `(none)` | — | `unknown` | see Call graph |
| `json` | `code, obj` | — | `unknown` | see Call graph |
## Methods (class / object)
| Name | Parameters |
|------|------------|
| `json` | `404, { error: 'not found' }` |
## What it imports / requires
- `node:http`
- `./subjects.js`
- `./handle.js`
## Call graph (identifiers invoked)
`snapshot`, `createServer`, `async`, `writeHead`, `end`, `stringify`, `json`, `push`, `parse`, `concat`, `toString`, `handle`, `reply`, `listen`, `write`, `on`, `close`, `exit`
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`.

View file

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