Skip to content

Commit 8493856

Browse files
committed
docs: align README quick-start with real public API (SymbolicValueType, runtime.orchestrator, message_bus)
Small ranked-progress polish: fix imports/constructors that no longer match the package and note the minimal supported surface.
1 parent d60ab6d commit 8493856

1 file changed

Lines changed: 25 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Every computation in the system follows a single abstract protocol defined by `P
4848
```
4949
INTAKE → PROCESS → EVALUATE → INTEGRATE
5050
↑ │
51-
└────────────────────┘
51+
└──────────────────────────────────────┘
5252
(feedback: should_continue)
5353
```
5454

@@ -61,10 +61,10 @@ The generic type parameters (`InputT`, `OutputT`, `ContextT`) ensure that each s
6161
`SymbolicValue` is the atomic unit of meaning in the system — a frozen Pydantic model carrying:
6262

6363
- **ULID identity** — globally unique, time-sortable, no coordination required
64-
- **Value type** — one of 23 enumerated kinds: `NARRATIVE`, `DREAM`, `RULE`, `PATTERN`, `TOKEN`, `CURRENCY`, `MASK`, `SIGNAL`, `ECHO`, `REFERENCE`, `ARCHIVE`, `CONFLICT`, `RESOLUTION`, `NODE`, `ROUTE`, `THRESHOLD`, `PROCESS`, `CONSUMPTION`, `EVOLUTION`, `LOCATION`, `AUDIENCE`, `ACADEMIA`, `ANTHOLOGY`
64+
- **Value type** — one of the enumerated kinds in `SymbolicValueType` (NARRATIVE, DREAM, RULE, PATTERN, TOKEN, CURRENCY, MASK, SIGNAL, ECHO, REFERENCE, ARCHIVE, …)
6565
- **Provenance chain** — every value records its origin; the `derive()` method creates a new value linked to its parent, building a directed acyclic graph of symbolic lineage
6666

67-
This is not a tagged union for dispatch convenience. The type system reflects an ontological claim: these 23 categories constitute the *morphological vocabulary* of the system. A `DREAM` value behaves differently from a `RULE` value not because of arbitrary business logic but because dreams and rules have different ontogenetic trajectories — dreams decay into echoes, rules compile into executable form.
67+
This is not a tagged union for dispatch convenience. The type system reflects an ontological claim: these categories constitute the *morphological vocabulary* of the system. A `DREAM` value behaves differently from a `RULE` value not because of arbitrary business logic but because dreams and rules have different ontogenetic trajectories — dreams decay into echoes, rules compile into executable form.
6868

6969
### Signals, Echoes, and Temporal Decay
7070

@@ -136,7 +136,7 @@ The subsystems communicate exclusively through the message bus. There are no dir
136136

137137
```bash
138138
# From source
139-
git clone https://github.com/organvm-i-theoria/organon-noumenon--ontogenetic-morphe.git
139+
git clone https://github.com/4444J99/organon-noumenon--ontogenetic-morphe.git
140140
cd organon-noumenon--ontogenetic-morphe
141141
pip install -e ".[dev]"
142142
```
@@ -145,29 +145,40 @@ pip install -e ".[dev]"
145145

146146
```python
147147
import anyio
148-
from autogenrec.core.symbolic import SymbolicValue, ValueType
149-
from autogenrec.core.messaging import MessageBus, Message
150-
from autogenrec.orchestrator import Orchestrator
148+
from autogenrec.core.symbolic import SymbolicValue, SymbolicValueType
149+
from autogenrec.core.signals import Message
150+
from autogenrec.runtime.orchestrator import create_default_orchestrator
151151

152152
async def main():
153153
# Create a symbolic value
154-
dream = SymbolicValue(value_type=ValueType.DREAM, content="recursive mirror")
154+
dream = SymbolicValue(type=SymbolicValueType.DREAM, content="recursive mirror")
155155

156156
# Derive a new value with lineage tracking
157-
pattern = dream.derive(value_type=ValueType.PATTERN, content="self-reference detected")
157+
pattern = dream.derive(type=SymbolicValueType.PATTERN, content="self-reference detected")
158158

159159
# Start the full 22-subsystem orchestrator
160-
orchestrator = Orchestrator()
161-
async with orchestrator:
160+
orchestrator = create_default_orchestrator()
161+
async with orchestrator.run_context():
162162
# Publish a message to the bus
163-
await orchestrator.bus.publish(
164-
"value.created",
165-
Message(payload=pattern)
163+
await orchestrator.message_bus.publish(
164+
Message.event(
165+
"value.created",
166+
"example",
167+
{"value_id": pattern.id, "content": pattern.content},
168+
)
166169
)
167170

168171
anyio.run(main)
169172
```
170173

174+
**Minimal supported imports** (stable public SDK surface for downstream organs):
175+
176+
- `SymbolicValue`, `SymbolicValueType` — `autogenrec.core.symbolic` (also re-exported from `autogenrec`)
177+
- `ProcessLoop`, `ProcessPhase`, `ProcessState` — `autogenrec.core.process`
178+
- `MessageBus` — `autogenrec.bus`
179+
- `Orchestrator`, `create_default_orchestrator` — `autogenrec.runtime.orchestrator`
180+
- `Message` — `autogenrec.core.signals`
181+
171182
### Development
172183

173184
```bash

0 commit comments

Comments
 (0)