tidaldb/tidal/docs/planning/milestone-0/phase-3/task-02-embedding-guides.md
jx12n 3bcfb3c576 feat: Bazel build, crate docs/ai-lookup, docker images, and engine hardening
- Add BUILD.bazel across tidal, tidal-net, tidal-server, tidalctl for bzlmod build
- Add tidal/ crate docs (README, CHANGELOG, CONTRIBUTING, AGENTS, CLAUDE, API, ARCHITECTURE) and ai-lookup reference
- Add docker standalone/cluster/deploy images, compose, and prometheus config
- Harden WAL (batch format, writer, dedup, diagnostics), text syncer/collectors, and vector registry
- Expand tidalctl CLI and tests; restructure WAL/visibility integration test suites
- Refine tidal-net transport/client/server and tidal-server cluster/scatter-gather
2026-06-07 18:29:38 -06:00

617 B
Raw Blame History

Task 02 — Embedding Guides (Axum/Actix/CLI)

Goal: show how to wire tidalDB into real hosts so customers dont guess.

Deliverables

  • Axum guide: builder in State, graceful shutdown via with_graceful_shutdown.
  • Actix guide: Data<TidalDb> example + metric endpoint mounting.
  • CLI embedding: minimal binary using builder + tidalctl for smoke test.
  • Docs page (mdx) referencing all three.

Acceptance Criteria

  • Each guide lives under /examples with README instructions.
  • Guides double as integration tests (run during CI).
  • Includes “cleanup” guidance referencing TempTidalHome helper.