Steward Platform — Documentation

This is the umbrella documentation for the Steward Platform monorepo. The platform is composed of independent packages; each package owns its own README.md and docs/ directory. This page is the entry point and links out to each package.

Start here

For the current implementation status of this checkout, read:

• docs/steward/current-repository-status.md
• docs/steward/convergence-verification.md — assistant convergence: targeted tests, real-model findings and open acceptance boundaries.
• 111 — Eén samenhangende assistent — active spec-kit delivery set: personal PA first; business workflows deferred; implementation plan, tasks and canonical acceptance scenarios.

Important: not every document under docs/ describes something that is already built. Some files are design/target-state artifacts; others point at code and verification that already landed. This repository currently has no separate docs/INDEX.md — this README.md is the entry point.

Packages

Package	Responsibility	Docs
registry	Canonical, tenant-isolated temporal fact store (CRU + eventstore + CQRS).	Architecture · Operations
dart_steward_workflow_engine	Steward Flows — executes definition-driven graphs of typed nodes (isolation, fan-out, supervisor, loop/timeout bounds).	Architecture · Operations

Layout

docs/                       # THIS file — platform-level overview + links
packages/
  dart_steward_data/
    README.md               # package overview
    docs/                   # data-service-specific architecture + operations
  dart_steward_workflow_engine/
    README.md               # package overview
    docs/                   # workflow-engine-specific architecture + operations
  flutter_steward_personal_assistant/
    README.md               # package overview
    docs/                   # frontend-specific architecture + operations
  pkg_steward_models/
    README.md               # package overview
    docs/                   # model/DTO-specific documentation
  <future packages>/
    README.md
    docs/

Each package keeps its documentation next to its code so related material stays together as the platform grows.

Conventions

• Current implementation status first: use docs/steward/current-repository-status.md to distinguish between built product state and design intent.
• Platform-level design artifacts (cross-package convergence decisions) live under docs/design/. These are design targets unless a spec or status page says the implementation is already verified. Current design artifacts include:
  • ux-design-system-a-prime.md — Steward Workspace UI design system (WidgetsApp + flat primitives; companion to ADR-016).
  • memory-architecture.md — hybrid 4-layer memory architecture (raw log → vector → knowledge graph → constitutional lens).
  • ux-brief.md — feel & layout brief.
  • interaction-contract.md — hard consistency rules.
  • trustworthy-assistant-guardrail-contract.md — product contract for keeping guardrails user-serving, source-first, and free of internal-control leakage.
• Architecture/decision records live under docs/decisions/ (ADR-0xx). They record accepted direction, but are not by themselves proof that every referenced codepath is already migrated.
• Package READMEs are English and follow the same shape: Features / Usage / Layout / Development.
• API reference is generated per package from the (English) doc comments:

  cd packages/<package>
  dart doc          # output in packages/<package>/doc/api/
  

• Definitions, specs, and task tracking for a feature live under specs/<NNN-feature>/ at the repo root.
• Adding a package? Copy the layout and skeletons from docs/PACKAGE_STRUCTURE_TEMPLATE.md (folder
  • barrel layout) and docs/PACKAGE_DOCS_TEMPLATE.md (docs shape), keep its code under packages/<name>/lib/src/ and its docs in packages/<name>/docs/, and add one row to the package table above. Mirror packages/dart_steward_data/ structurally.