3bcfb3c576
- 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
13 lines
556 B
Markdown
13 lines
556 B
Markdown
# 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.
|