jx12n ad4134e280 chore: doc consolidation, seven-dimension review fixes, and commit hooks

- Eliminate the tidal/ self-contained doc mirror; docs now have two canonical
  homes (root *.md and docs/), with planning/specs/research/reviews moved up
- Remove stale .agents/skills and .ai mirrors; canonicalize skills under .claude/
- Add pre-commit hook + scripts/check-docs.sh doc-guard + scripts/install-hooks.sh
- Implement M0-M10 seven-dimension review findings across engine, net, server,
  and tidalctl (durability, replication, query, WAL, storage, CLI hardening)

2026-06-08 22:46:28 -06:00

3.5 KiB

Raw Blame History

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)