Skip to content

Commit 49cb85b

Browse files
committed
docs: domain-neutral naming in paracosm + ecosystem guides
PARACOSM.md and ECOSYSTEM.md swap external-executor-specific naming for digital-twin phrasing. Schema semantics are unchanged.
1 parent 80fcc22 commit 49cb85b

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/PARACOSM.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Or run the hosted demo at [paracosm.agentos.sh/sim](https://paracosm.agentos.sh/
4646
Every `runSimulation()` call returns a Zod-validated `RunArtifact` exported from the `paracosm/schema` subpath. One shape covers three simulation modes, discriminated on `metadata.mode`:
4747

4848
- `turn-loop`: civilization sims (paracosm's built-in mode). Populates `trajectory.timepoints[]` and `decisions[]` with per-turn specialist notes.
49-
- `batch-trajectory`: digital-twin simulations (digital-twin). Labeled timepoints over a horizon, populated by external LangGraph-style executors.
49+
- `batch-trajectory`: digital-twin simulations. Labeled timepoints over a horizon, populated by external LangGraph-style executors.
5050
- `batch-point`: one-shot forecasts. Overview and risk flags only, no trajectory.
5151

5252
```typescript
@@ -69,7 +69,7 @@ artifact.trajectory?.timepoints?.forEach((tp) => {
6969

7070
The schema exposes 11 content primitives (`RunMetadata`, `WorldSnapshot`, `Score`, `HighlightMetric`, `Timepoint`, `TrajectoryPoint`, `Trajectory`, `Citation`, `SpecialistDetail`, `SpecialistNote`, `RiskFlag`, `Decision`) plus operational types (`Cost`, `ProviderError`). Every primitive carries an optional `scenarioExtensions?: Record<string, unknown>` escape hatch for domain-specific fields that must not pollute the universal shape.
7171

72-
Non-TypeScript consumers generate equivalent types from JSON Schema: `npm run export:json-schema` emits `schema/run-artifact.schema.json` and `schema/stream-event.schema.json`. Python projects use `datamodel-codegen`; any ecosystem with a JSON-Schema code generator adopts cleanly. Full adoption walkthrough at [paracosm/docs/adoption/digital-twin.md](https://github.com/framersai/paracosm/blob/master/docs/adoption/digital-twin.md).
72+
Non-TypeScript consumers generate equivalent types from JSON Schema: `npm run export:json-schema` emits `schema/run-artifact.schema.json` and `schema/stream-event.schema.json`. Python projects use `datamodel-codegen`; any ecosystem with a JSON-Schema code generator adopts cleanly.
7373

7474
### Subjects and interventions
7575

0 commit comments

Comments
 (0)