jordan/tidaldb
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
b55ad70141
tidaldb/tidal/docs/planning/milestone-0/phase-3/task-01-quickstart-and-doctests.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

556 B
Raw Blame History

Task 01 — Quickstart + Doctests

Goal: demonstrate embedding tidalDB in <20 LOC and keep it compiling forever.

Deliverables

  • examples/quickstart.rs referenced from README + VISION.
  • Corresponding snippet in docs that uses Rust fenced code block with no_run + doctest harness.
  • CI hook (cargo test --doc --examples) wired into main workflow.

Acceptance Criteria

  • Quickstart writes a single signal and reads it back once M1 lands, but for now asserts builder + health_check.
  • Fails CI if builder API changes without updating docs.