haiku.rag/docs
Yiorgis Gozadinos 483c0ec354
Give the docs an architecture page and one extras list
overview.md repeated the landing page: the same install-and-ask block and
five of six identical links. It was positioning prose, where the docs had no
page describing how the system works.

Rewrite it as Architecture, following the data through: source adapter,
converter, chunker, embedder, transaction; then storage and its versioning;
then retrieval, with the 10x rerank fetch and section-bounded expansion; then
the two capabilities; then laptop versus ingester. Retitled in the nav and on
the landing page, filename kept so existing links resolve.

Extras were listed in three places and none was complete.
docs/installation.md now carries a table of all fifteen slim extras, what each
provides, and which the full package already includes.
haiku_rag_slim/README.md names them and links there. The claim that other
providers need their own pydantic-ai extra was wrong: haiku.rag-slim defines
anthropic, google, groq, mistral, bedrock and vertexai itself.

configuration/storage.md opens with the four operational constraints, which
were either buried in an S3 section or undocumented: one writer per URI,
reader lag by read_consistency_interval_seconds, migrate after a
schema-changing upgrade, and the fixed embedding dimension with what
ConfigMismatchError means and which rebuild mode resolves it.

The one-writer rule is stated as a haiku.rag constraint, which is what it is:
the multi-table lock, version snapshot and rollback are process-local, so a
second writer can commit inside another's transaction and be reverted by its
rollback. storage.md and ingester.md both claimed it was a LanceDB property
that corrupts manifests. The S3 deployment section now links to the
constraint instead of restating it.

Get started reads index, Quickstart, Installation, Architecture. The landing
page's list was missing Installation.
2026-08-20 15:07:06 +03:00
..
capabilities Refuse to compact evidence the host kept no record of 2026-08-13 15:46:23 +03:00
configuration Give the docs an architecture page and one extras list 2026-08-20 15:07:06 +03:00
img Add ingester screenshot 2026-05-27 15:53:01 +03:00
stylesheets Landing page hero with TUI screen recording 2026-05-20 16:56:25 +03:00
apps.md Bind app example backend to loopback and document its lack of auth 2026-07-08 11:37:03 +03:00
benchmarks.md Update benchmarks for qwen3.8 2026-08-20 11:52:40 +03:00
changelog.md Improve documentation 2025-11-28 13:10:03 +02:00
chat.md Update caps documentation 2026-08-13 14:08:14 +03:00
cli.md Accept images on CLI ask/analyze and MCP tools 2026-07-25 10:35:25 +03:00
custom-pipelines.md Linting, doc edits 2026-08-18 12:18:10 +02:00
development.md Docs 2026-04-24 14:42:52 +03:00
index.md Give the docs an architecture page and one extras list 2026-08-20 15:07:06 +03:00
ingester.md Give the docs an architecture page and one extras list 2026-08-20 15:07:06 +03:00
installation.md Give the docs an architecture page and one extras list 2026-08-20 15:07:06 +03:00
mcp.md Accept images on CLI ask/analyze and MCP tools 2026-07-25 10:35:25 +03:00
overview.md Give the docs an architecture page and one extras list 2026-08-20 15:07:06 +03:00
python.md Linting, doc edits 2026-08-18 12:18:10 +02:00
remote-processing.md Wire providers.docling_serve.timeout through to the client 2026-08-19 13:30:45 +03:00
tools.md replace haiku.skills with native Pydantic AI capabilities 2026-07-24 15:26:17 +03:00
tuning.md Remove the wix evaluation dataset 2026-08-14 14:46:51 +03:00
tutorial.md replace haiku.skills with native Pydantic AI capabilities 2026-07-24 15:26:17 +03:00