Skip to content

Latest commit

 

History

History
37 lines (31 loc) · 1.82 KB

README.md

File metadata and controls

37 lines (31 loc) · 1.82 KB

Lucid documentation

These documents explain Lucid's purpose and current system shape. They are intentionally smaller than framework documentation: Lucid is an experimental product, not a developer SDK.

Read order

  1. Project posture explains the product hypothesis, current stage, non-goals, and boundaries that should survive refactoring.
  2. Architecture maps the web app, services, PostgreSQL state, Heddle runtime, and authentication boundary.
  3. Hosted execution records the external Heddle host, public adopter SDK, Lucid-owned product MCP boundary, database boundary, and the remaining composition and managed-runtime evidence.
  4. How it works follows an interest through agent wakes, network messages, findings, feedback, pause, and recovery.
  5. Coding conventions defines Lucid's vertical-slice Hexagonal Architecture, storage ports, PostgreSQL adapters, and dependency rules.
  6. Running locally covers setup, migrations, simulation, authentication modes, and checks.
  7. Deploying defines the portable ARM64 server image, generic hosted configuration, explicit migration sequence, and managed-evidence boundary.

The root README remains the quickest product tour. More detailed maintenance notes live beside the server, runtime, authentication, web, and simulator implementations.

Source of truth

These files describe the durable product and architecture posture. For exact behavior, use the live implementation and nearby tests as the source of truth. Update these documents when a change alters a user flow, an ownership boundary, persistence topology, or deployment assumption. Do not copy short-lived task plans or local-machine details into them.