History

jx12n 1092d34c39 feat: kubernetes deployment, OpenAPI spec, guides, and docker consolidation - Add k8s/ manifests (StatefulSet, kustomize, PDB, ServiceMonitor) + docs/runbooks/kubernetes.md - Add tidal-server/src/openapi.rs (utoipa OpenAPI spec) and wire into router - Add docs/guides/ (build-a-feed-app, embeddings, server-deployment) + foryou_feed example - Consolidate tidal/docker/ into root docker/ (single canonical home) - Update API.md, QUICKSTART.md, README.md, CLAUDE.md, check-docs.sh accordingly		2026-06-09 17:06:34 -06:00
..
guides	feat: kubernetes deployment, OpenAPI spec, guides, and docker consolidation	2026-06-09 17:06:34 -06:00
ops	chore: doc consolidation, seven-dimension review fixes, and commit hooks	2026-06-08 22:46:28 -06:00
planning	chore: doc consolidation, seven-dimension review fixes, and commit hooks	2026-06-08 22:46:28 -06:00
profiling	feat: complete M6-M7 + Enterprise Readiness milestones; split oversized source files per CODING_GUIDELINES §9	2026-02-23 22:41:16 -07:00
research	chore: doc consolidation, seven-dimension review fixes, and commit hooks	2026-06-08 22:46:28 -06:00
reviews	fix: M0-M10 code-review pass2 remediation — all 91 findings	2026-06-09 12:21:00 -06:00
runbooks	feat: kubernetes deployment, OpenAPI spec, guides, and docker consolidation	2026-06-09 17:06:34 -06:00
specs	chore: doc consolidation, seven-dimension review fixes, and commit hooks	2026-06-08 22:46:28 -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	feat: kubernetes deployment, OpenAPI spec, guides, and docker consolidation	2026-06-09 17:06:34 -06:00

README.md

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, M0–M8).

#	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/`

ROADMAP.md — milestones M0–M10, phase status, known gaps
PRODUCT_ROADMAP.md · architecture-review.md · roadmap-cohort-analysis.md · site-cohort-analysis.md
Per-milestone phase/task archive: planning/milestone-0,1,2,3,5,7,8,9,10,p/

Code reviews — `reviews/`

M0–M10 code review — 2026-06-07 — seven-dimension re-review, 88 verified findings
M0–M10 code review — 2026-06-08 — seven-dimension review, 142 findings (latest pass)
M0–M10 seven-dimension review — additional pass (2 BLOCKERs: signal-checkpoint trim, 30-day window)

Guides — `guides/`

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

Build a feed app — end-to-end TikTok/Reels-style "For You" feed, embedded and over HTTP
Embedding integration — wiring a real embedding model (OpenAI / Cohere / local) into the write + query paths
Server deployment — running the tidal-server HTTP service: config, auth, the served OpenAPI spec, Docker
Ranking-profile reference: ai-lookup/services/ranking-profiles.md — all 25 built-in profiles