Docs
This product site is the short path. The manuals below are the deep path: every field, flag, error code, and connector option. They live in the repo as Markdown and open on GitHub.
Normative contracts (JSON Schema, Query IR, typed errors) stay in
planning/. If a
manual and planning/ disagree, planning wins. Product rule
labels (D17–D22) are explained on
Decisions
Contribute — do not treat the bare id as enough context.
Start here if you are writing YAML from zero: from-scratch.md and field-reference.md. Index: docs/en/README.md.
English guides
| Guide | Contents |
|---|---|
| from-scratch.md | Own folder, Postgres example, validate, prove the right YAML is loaded |
| field-reference.md | Every field, enum, *Env key, and REST option |
| point-your-folder.md | CLI, Dockerfile vs .dev, deploy/prd vs prd-tst |
| scope.md | What the product is and is not |
| project-files.md | File discovery and precedence |
| cli.md | Every command and flag |
| http-mcp.md | HTTP /v1, MCP, auth, bind, CORS |
| queries.md | Catalog SQL vs Query IR: accepted and refused shapes |
| responses.md | Output envelope, column types, json cells, shape |
| connectors.md | Source types, bindings, pushdown |
| errors.md | Typed error codes |
| multi-user-safety.md | Row scope on the credential (decision D21) |
| environments.md | Compose, images, PRD simulation, scripts |
| install.md | Image, Go, DuckDB, standalone zip |
| build.md | Go, -tags duckdb, Docker |
Example in action
End-to-end fictional company demo (silos + console + qLLM HTTP/MCP): jpandrade30/SmallDemo.
Protocol & history
Additive protocol differences:
0.1.0 → 0.2.0. Full release notes:
Changelog (from root
CHANGELOG.md).
Contribute
Fork/PR workflow, contract checklist, and Code of Conduct: Contribute · CONTRIBUTING.md · CODE_OF_CONDUCT.md.
Other languages
The same 15 guides exist in Português, Español, and 中文. This product site stays English-only.
Still onboarding?
Use the short product pages first, then jump into the manuals when you need every option.