Brummel/Aura
1
0
Fork 0
Code Issues 33 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: authoring guide for op-scripts, process & campaign documents

Browse Source 
Close two milestone-fieldtest doc-gaps (F6/F8) with one pass now that the
surfaces are stable. A newcomer could only learn the three headless JSON
artifact kinds from the fieldtest corpus: the op-script grammar was
undocumented (#208) and there was no worked process/campaign example nor a
pointer to the discoverable metric vocabulary (#197).

Add docs/authoring-guide.md — a worked, verified example per artifact kind
(op-script -> graph build; process document -> process validate/register;
campaign document -> campaign validate/register/run), every command run
against the binary and its output transcribed. Documents all six ops
(source/input/add/feed/connect/expose) with their JSON shapes, and teaches
the metric roster split (rankable / gate / | generalize) pointing at
'aura process introspect --metrics' as the source of truth rather than
hand-copying the rosters. A short paragraph in project-layout.md links it.

Docs only; no code or CLI change (the surfaces already suffice). Grammar
grounded on construction.rs; examples faithful to the milestone corpus.

closes #197
closes #208
This commit is contained in:
Brummel
2026-07-04 15:30:03 +02:00
parent 61c8828fad
commit e7c7bded3e
2 changed files with 328 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/project-layout.md
+10
View File
@@ -90,6 +90,16 @@ logic. IONOS LLMs appear only as a *runtime data source* (e.g. a news-agent node
emitting a bias), recorded before it enters a backtest, and only with your
per-session consent.
Wiring *already-built* node types into a graph, and naming experiment intent
over such a graph, is a separate, closed-vocabulary **data** surface, not Rust:
an **op-script** (`aura graph build`) assembles a strategy blueprint from node
types already in the vocabulary, a **process document** (`aura process`) names
a validation/eval methodology, and a **campaign document** (`aura campaign`)
names instruments × windows × strategy × param axes × process. All three are
headless-authorable and introspectable without a build. See
[`docs/authoring-guide.md`](authoring-guide.md) for the worked grammar and
command sequences.
## A day in the life
1. **You** (in Claude Code, inside `ger40-lab/`): "I suspect the 3rd 15m candle