Document every repo in Sphinx, catalog PDFs, and verae-ops
Some checks are pending
offline / test (push) Waiting to run
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:
parent
5ad3222def
commit
e401635fd6
222 changed files with 4498 additions and 123 deletions
48
docs/modules/verae-archive-worm/archive.md
Normal file
48
docs/modules/verae-archive-worm/archive.md
Normal 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`.
|
||||
|
||||
49
docs/modules/verae-archive-worm/bloom.md
Normal file
49
docs/modules/verae-archive-worm/bloom.md
Normal 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`.
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue