Canonical platform root for Steward Platform vision, architecture, contracts, ADRs, and phased plans.
- Dart 90.8%
- Shell 5.1%
- C++ 1.9%
- CMake 1.5%
- Python 0.4%
- Other 0.3%
The embed-worker (L1) was purely in-memory: on every app restart it cleared the VectorIndex and re-embedded ALL L0-entries via the LLM — a full Ollama embedding burst on each launch, even though the graph layer (L2) was already cached by the previous commit. Mirrored the graph-cache fix onto L1: VectorIndexEntry/VectorIndex gained toJson/loadFromJson; MemoryEmbedWorker + MemoryL1Layer + StewardPaCore gained a cache-path; config_loader writes vector_cache.json next to the L0 store. When cachePath is set, start() loads the index from disk instead of rebuilding, and the existing hash-guard skips already-embedded entries → restart = zero re-embed. Verified: embed_worker_cache_test proves a second worker (fresh index + loaded cache) performs 0 embed calls. Full suite 206 tests green (incl. live Ollama). |
||
|---|---|---|
| .specify | ||
| docs | ||
| packages | ||
| scripts | ||
| specs | ||
| tool/lint | ||
| .env.example | ||
| .gitignore | ||
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.
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
- Platform-level design artifacts (cross-package convergence decisions) live under
docs/design/. Active ones: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.
- Architecture/decision records live under
docs/decisions/(ADR-0xx). ADR-016 supersedes ADR-014 §1/D1 on the UI base library. - 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 underpackages/<name>/lib/src/and its docs inpackages/<name>/docs/, and add one row to the package table above. Mirrorpackages/dart_steward_data/structurally.
- barrel layout) and