diff --git a/README.md b/README.md index 19c82853..eb78b1a3 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,10 @@ Use KTX when you want agents to: Supports PostgreSQL, Snowflake, BigQuery, ClickHouse, MySQL, SQL Server, and SQLite. +

+ KTX ingestion flow from source systems through validation to wiki and semantic-layer outputs +

+ ## Agent Setup Ask an agent such as Claude Code, Codex, Cursor, or OpenCode to install and diff --git a/docs-site/public/images/ingestion-flow-transparent.svg b/docs-site/public/images/ingestion-flow-transparent.svg new file mode 100644 index 00000000..6fa1a40a --- /dev/null +++ b/docs-site/public/images/ingestion-flow-transparent.svg @@ -0,0 +1,211 @@ + + KTX ingestion flow + Source systems flow through source adapters, context builder, reconciliation, and validation to create wiki Markdown and semantic-layer YAML outputs. + + + + + + + + + + + + + + + + + + + + + + + + + Databases + Schemas, columns, keys, + row counts, and query + history. + + + PostgreSQL + + Snowflake + + BigQuery + + SQLite + + + + + + + BI tools + Dashboards, questions, + explores, usage, and trusted + examples. + + + Metabase + + Looker + + + + + + + Modeling code + Existing metrics, dimensions, + models, joins, and entities. + + + dbt + + LookML + + MetricFlow + + + + + + + Docs and notes + Policies, caveats, team + definitions, and analyst + context. + + + Notion + + Any text + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1 + Source adapters + Read each configured system in + its native shape. + + + + + + 2 + Context builder + Turn source evidence into + proposed context updates. + + + + + + 3 + Reconciliation + Merge new evidence with the + context that already exists. + + + + + + 4 + Validation + Check references and + semantics before agents rely on + them. + + + + + + + + wiki/*.md + Wiki + + + free-form + + auto-maintained + + Definitions, caveats, policies, analyst notes, and + business language that agents can search. + + + + + + semantic-layer/*.yaml + Semantic layer + + + structured + + executable + + auto-maintained + + Metrics, joins, tables, dimensions, filters, and + segments that KTX can validate and compile into + SQL. + + + + + references + + + diff --git a/docs-site/public/images/ingestion-flow.png b/docs-site/public/images/ingestion-flow.png new file mode 100644 index 00000000..49bc544f Binary files /dev/null and b/docs-site/public/images/ingestion-flow.png differ