tidaldb/docs
jordan 44820d4f81
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
ci: gate the image on deterministic suites; the rolling upgrade becomes pre-release
Four data points settle this. mp_rolling_upgrade_no_loss_no_stall passed in
pipelines #5 and #6 and failed in #9 and #10, all on the same 3 CPU / 6Gi step and
all four ending identically:

  cluster_lifecycle.rs:362  timed out: WAL relay alone must reconverge all three
                            nodes to 1e-6 after the rolling upgrade

The same test on the same commit passes locally in 19.61s. It spawns three real
tidal-server processes — each with its own WAL, HNSW index, gRPC transport and
tokio runtime — and asks them to reconverge to 1e-6 inside 180s, on a node with
~1700m free CPU shared with the production cluster. Two passes and two failures is
a coin flip, and a coin flip that blocks image builds teaches everyone to re-run
until it goes green, which is how a gate stops being one.

I did not raise the budget again. That would be loosening a measured threshold to
hide the hardware, and it is the third time this session that the honest answer
was "the number is right, the environment is the finding".

This is the escalation task 01 prescribed verbatim: a tier-3 three-process test
does not belong on a 4-CPU shared node, so it becomes a documented pre-release
step run where it demonstrably passes. It is in
docs/runbooks/deploy-verification.md with the command and the expected 20s, and it
still runs nightly inside cluster_lifecycle where a flake costs a re-read of the
morning report instead of a blocked release.

The image is now gated by `fast-suites`: 51 tests across nine deterministic
in-process suites, no spawned processes, no convergence budget to starve — so its
verdict means the same thing on a loaded shared node as on a workstation. It
catches the class of regression that actually reached main today: cluster_routes
asserting a wire fabrication deleted hours earlier.

Also removes the last resource anchor that made step order load-bearing. Moving a
step broke an anchor defined on it three times in one session (resources-light,
cargo_env, resources-heavy); with the gate gone the heavy shape has exactly one
consumer, so it is written inline with the reason recorded.
2026-08-31 02:24:43 -06:00
..
guides feat(cluster): separate operator authority from data-plane access 2026-08-22 00:57:01 -06:00
legal feat(m12): multi-vector user preference modeling + ANN candidate-gen 2026-06-23 09:52:36 -06:00
ops harden: restore CI verification, remove four wire-level fabrications, instrument the 401 path 2026-08-30 20:55:58 -06:00
planning harden: restore CI verification, remove four wire-level fabrications, instrument the 401 path 2026-08-30 20:55:58 -06:00
profiling fix(m12p6): 6-bug k3s 3-shard cluster repair (rc8+rc9) 2026-06-16 22:34:21 -06:00
research feat(m12): multi-vector user preference modeling + ANN candidate-gen 2026-06-23 09:52:36 -06:00
reviews feat(m11): observability+ops (m11p8) + perf-sweep wave 2 T2 2026-06-13 09:17:49 -06:00
runbooks ci: gate the image on deterministic suites; the rolling upgrade becomes pre-release 2026-08-31 02:24:43 -06:00
specs docs(m12): refresh API, specs, ops, and roadmap to the shipped M12 reality 2026-06-23 21:39:55 -06:00
content-strategy.md feat: complete Milestone 5 — full-text search, RRF fusion, and creator search 2026-02-21 23:53:16 -07:00
personal-briefing-beachhead.md feat: M0p1 runtime skeleton, M0p2 tooling & diagnostics, m1p4 signal ledger 2026-02-20 20:32:00 -07:00
README.md docs(m12): refresh API, specs, ops, and roadmap to the shipped M12 reality 2026-06-23 21:39:55 -06:00
roadmap-to-cluster.md feat(m11): sharding × replication + rebalancing (m11p6 L3-L5) 2026-06-13 18:23:43 -06:00

tidalDB Engineering Docs

The engineering documentation home. Top-level product docs (VISION, USE_CASES, SEQUENCE, ARCHITECTURE, API, QUICKSTART, CODING_GUIDELINES, thoughts) live at the repository root; everything below is the deeper engineering record.

This and the repo root are the two canonical doc homes. There is intentionally no per-crate doc mirror (no tidal/docs/). Edit the canonical file, never a copy.

Component specs — specs/

The authoritative component specifications (status: Implemented, M0M12).

# Spec # Spec
00 Architecture overview 08 Query engine
01 Storage engine 09 Ranking & scoring
02 Entity model 10 Feedback loop
03 Signal system 11 Schema
04 Relationships 12 Cold start
05 Cohorts 13 Concurrency
06 Text retrieval 14 Scale architecture
07 Vector retrieval

Planning — planning/

Code reviews — reviews/

Guides — guides/

Task-oriented, build-an-app docs (complements the root QUICKSTART.md and API.md):

Operations — ops/ and runbooks/

Research — research/

ANN (1, 2) · Tantivy (1, 2) · Signal ledger (1, 2) · WAL · Type system · Tooling & diagnostics · Enterprise-readiness risks

Profiling — profiling/

Hotspot analysis · Scale baselines · Signal memory · Signal rollup eval · Social scale · Tantivy merge tuning · USearch tuning

Strategy

Content strategy · Personal-briefing beachhead