75 lines
3.7 KiB
Markdown
75 lines
3.7 KiB
Markdown
---
|
||
name: "Correx Documentation"
|
||
description: "Home of the Correx deterministic LLM orchestration runtime"
|
||
depth: 1
|
||
links:
|
||
- "./architecture/overview.md"
|
||
- "./design/spec-v0.1.md"
|
||
- "./decisions/adr-0000-invariants.md"
|
||
- "./modules/core-module-spec.md"
|
||
- "./epics/epics.md"
|
||
---
|
||
|
||
# Correx Documentation
|
||
|
||
Correx is a **local‑first, event‑sourced orchestration kernel** for structured LLM workflows.
|
||
It wraps probabilistic language models in a deterministic shell: models propose, the harness validates, approves, and records everything as an immutable event log.
|
||
|
||
## Navigate by Section
|
||
|
||
### Architecture
|
||
- [System Overview](./architecture/overview.md)
|
||
- [Event Model](./architecture/event-model.md)
|
||
- [Replay Model](./architecture/replay-model.md)
|
||
- [Context Layers](./architecture/context-layers.md)
|
||
- [Security Boundaries](./architecture/security-boundaries.md)
|
||
|
||
### Design Sketches
|
||
- [Spec v0.1](./design/spec-v0.1.md)
|
||
- [Design Document v0.1](./design/des-doc-v0.1.md)
|
||
- [Missing Pieces & Language/Stack](./design/lang-framewok-missing-pieces.md)
|
||
- [Potential Future Semantic Rules](./design/funure-semantic-rules.md)
|
||
- [Project Structure](./design/structure.md)
|
||
|
||
### Architecture Decision Records
|
||
- [ADR‑0000: Invariants](./decisions/adr-0000-invariants.md)
|
||
- [ADR‑0001: Event Sourcing](./decisions/adr-0001-event-sourcing.md)
|
||
- [ADR‑0002: Kotlin Choice](./decisions/adr-0002-kotlin-choice.md)
|
||
- [ADR‑0003: Compression Strategy](./decisions/adr-0003-compression-strategy.md)
|
||
- [ADR‑0004: Approval Tier Design](./decisions/adr-0004-approval-tier-design.md)
|
||
- [ADR‑0005: Persistence Choice](./decisions/adr-0005-persistence-choice.md)
|
||
- [ADR‑0006: Event Store Append‑Only](./decisions/adr-0006-event-store-append-only.md)
|
||
- [ADR‑0007: Projection & Replay Determinism](./decisions/adr-0007-projection-replay.md)
|
||
- [ADR‑0008: Contract Testing Enforcement](./decisions/adr-0008-contract-enforcment-with-tests.md)
|
||
- [ADR‑0009: Replay Engine & Projection Separation](./decisions/adr-0009-replay-engine-projection-separation.md)
|
||
|
||
### Module Specifications
|
||
- [Core Module (overview)](./modules/core-module-spec.md)
|
||
- [Events (`:core:events`)](./modules/core-events-submodule-spec.md)
|
||
- [Sessions (`:core:sessions`)](./modules/core-sessions-submodule-spec.md)
|
||
- [Transitions (`:core:transitions`)](./modules/core-transitions-submodule-spec.md)
|
||
- [Validation (`:core:validation`)](./modules/core-validation-submodule-spec.md)
|
||
- [Approvals (`:core:approvals`)](./modules/core-approvals-submodule-spec.md)
|
||
- [Artifacts (`:core:artifacts`)](./modules/core-artifacts-submodule-spec.md)
|
||
- [Context (`:core:context`)](./modules/core-context-submodule-spec.md)
|
||
- [Tools (`:core:tools`)](./modules/core-tools-submodule-spec.md)
|
||
- [Inference (`:core:inference`)](./modules/core-inference-submodule-spec.md)
|
||
- [Orchestration (`:core:orchestration`)](./modules/core-orchestration-submodule-spec.md)
|
||
- [Module Organisation Guide](modules/modules-and-spec.md)
|
||
|
||
### Epics (Build Plan & Resolutions)
|
||
- [Epic Overview & Ordering](./epics/epics.md)
|
||
- [Epic 1: Event System](./epics/epic-1.md)
|
||
- [Epic 1 Resolution](./epics/epic-1-resolution.md)
|
||
- [Epic 1.5: Store Hardening](./epics/epic-1.5.md)
|
||
- [Epic 1.5 Resolution](./epics/epic-1.5-resolution.md)
|
||
- [Epic 2: Session Lifecycle](./epics/epic-2.md)
|
||
- [Epic 2 Resolution](./epics/epic-2-resolution.md)
|
||
- [Epic 3: Transition Engine](./epics/epic-3.md)
|
||
- [Epic 3 Resolution](./epics/epic-3-resolution.md)
|
||
- [Epic 4: Validation Pipeline](./epics/epic-4.md)
|
||
- [Epic 4 Resolution](./epics/epic-4-resolution.md)
|
||
|
||
---
|
||
|
||
*Every `.md` file in this documentation carries YAML front‑matter with a `name`, `description`, `depth`, and explicit `links` for machine‑readable navigation.* |