yams/docs/roadmap.md
Trevon 8dd0ef1c33
docs: MSI daemon, p2p status, ONNX Runtime search order (#267)
* docs: MSI ships the daemon; p2p sync shipped in 0.20.0

install.md said the MSI lacks yams-daemon.exe and yams-mcp-server.exe.
Both ship from the next published release (packaging/windows/yams.wxs).
0.20.4 was not published, so name 0.20.3 as the last MSI without them.

roadmap.md listed p2p sync as unshipped. Whole-corpus replication
shipped in 0.20.0. List what is still open.

Signed-off-by: trvon <me@trevon.dev>

* docs: give the ONNX Runtime search order

install.md said only that a system copy is preferred over the bundled
one. State the order from plugins/ort_runtime/ort_runtime_resolution.h:
runtime_library pin, system copy >= 1.23, bundled lib/yams/onnxruntime/,
with YAMS_ONNX_RUNTIME_LIB / YAMS_ONNX_RUNTIME_DIR overriding all three.
Quote the real log line.

Signed-off-by: trvon <me@trevon.dev>

---------

Signed-off-by: trvon <me@trevon.dev>
2026-10-02 18:48:50 -06:00

2 KiB

Roadmap

YAMS is pre-1.0. The roadmap describes direction, not a compatibility promise.

Principles

  • Local-first: a corpus remains usable without an account or hosted service.
  • Portable: users can inspect, export, move, and delete their data.
  • Measured: retrieval and performance changes require reproducible evidence.
  • Small surface: command help, schemas, tests, and benchmarks are canonical.
  • Interoperable: CLI, MCP, mobile, and plugins share the same corpus semantics.

Current focus

  • Make daemon lifecycle and recovery predictable under load and crashes.
  • Improve search, graph, and grep retrieval quality per token returned.
  • Keep Simeon as the primary embedding and retrieval optimization backend.
  • Align candidate generation, fusion, and reranking with measured query classes.
  • Harden mobile corpus access through the stable local C ABI.
  • Reduce duplicated infrastructure, configuration, and documentation.

Peer-to-peer corpus sharing

Goal: direct, selective sharing between corpora, with no central service owning either one. Whole-corpus sync between daemons shipped in 0.20.0 (p2p.md). Still open:

  • Collection-, tag- and path-scoped manifests with a dry-run preview.
  • Peer discovery. Peers are added by hand with yams p2p enroll.
  • Conflict-preserving metadata and graph merge. Sync is last-writer-wins.

Before 1.0

  • Define and test the stable corpus, plugin, and mobile ABI boundaries.
  • Establish multi-corpus retrieval quality gates and release baselines.
  • Complete export/import with tags, relationships, and provenance intact.
  • Separate fast correctness tests from explicit stress and soak lanes.
  • Ship reproducible artifacts for supported operating systems and architectures.

Later

  • Scoped peer-to-peer sharing between teams
  • Cross-repository retrieval federation
  • Offline mobile corpus import, inspection, search, export, and deletion
  • User-controlled context exchange between agents and applications

Completed work belongs in release history, benchmarks, and source control—not as a growing archive of roadmap prose.