| title | Reference |
|---|---|
| description | Exhaustive technical specs — auto-generated where possible. |
Reference pages are exhaustive and machine-comparable. Half are auto-generated from the source of truth (Cobra command tree, OpenAPI spec, .proto files); the rest are hand-maintained schemas.
The auto-generated pages land via make docs-regen; CI
fails on drift between the source of truth and the
committed page.
- CLI reference — one page per
pg_hardstoragesubcommand, auto-generated from the Cobra command tree. 216 pages today.
- REST API overview — the v1 contract, auth, conventions, exit codes.
How to write a plugin against the pg_hardstorage interfaces.
- Overview — Tier-1 vs Tier-2, the seven plugin types, registration patterns, trust posture.
- Storage contract
- Source contract
- Encryption (KMS) contract
- Compression contract
- Renderer contract
- Sink contract
- LLM provider contract
- Tier-2 protocol (
go-plugin) - Tier-1 vs Tier-2 decision matrix
Hand-written for v1.0; will be auto-generated as the
reflectors land (see DOC_PLAN.md
"Auto-generation map").
- Exit codes — the 0-10 contract and the namespace → exit-code mapping.
- Error codes — catalogue of structured error codes, grouped by domain.
- KEKRef schemes —
local:,aws-kms://,gcp-kms://,azure-kv://,vault-transit://,pkcs11://. - Storage URL schemes —
file://,s3://,azblob://,gcs://,sftp://,scp://. - Build flavours — default, FIPS, PKCS#11, Firecracker.
- Manifest schema — on-disk backup manifest fields and canonicalisation rule.
- Output event schema —
Event,Result, andErrorwire format. - Skill schema — LLM skill YAML format and tool allowlist.
- Metric catalogue — Prometheus metric names; implementation pending (see SPEC drift).
Runbooks for the seven named disaster scenarios + control-plane setup.
These reference pages will land as the auto-generators wire up (the DOC_PLAN.md "Auto-generation map" tracks what's outstanding):
- gRPC reference (auto-generated from
proto/**/*.protoviaprotoc-gen-doc) - Configuration schema (auto-generated from
internal/config.Schema()reflection) - Audit-event schema (struct-reflection emitter)
- Kubernetes CRDs (auto-generated from
api/crd/) - Filesystem layout, compatibility matrix